Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
qdelamea-aneo authored Feb 27, 2024
0 parents commit 98c58fd
Show file tree
Hide file tree
Showing 9 changed files with 826 additions and 0 deletions.
6 changes: 6 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
version: 2
updates:
- package-ecosystem: "npm"
directory: "/" # Location of package manifests
schedule:
interval: "weekly"
23 changes: 23 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: CI

on:
push:
branches: [main]
pull_request:
branches: [main]

env:
NODE_VERSION: 16.x

jobs:
typecheck:
runs-on: ubuntu-latest

steps:
- uses: actions/setup-node@v3
with:
node-version: ${{ env.NODE_VERSION }}
- uses: actions/checkout@v3
- run: |
npm install
npm run typecheck
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules
dist
.env
1 change: 1 addition & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{}
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# notion-sdk-typescript-starter

This is a template repository for getting started with the [Notion SDK](https://github.com/makenotion/notion-sdk-js)
and [TypeScript](https://www.typescriptlang.org/).

To use this template, click the big green "Use this template" button in the upper-right corner. After some questions,
GitHub will create a new clone under your account, and then you can get started customizing.

## Features

- TypeScript for type checking.
- [Prettier](https://prettier.io/) for code formatting.
- A minimal GitHub Actions workflow that typechecks your code.
- [Dotenv](https://www.npmjs.com/package/dotenv) for configuring your Notion API token.
- [Dependabot](https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates)
for ensuring your (and this template's!) dependencies are up to date.
- Our lovely Notion SDK!

## What to do after duplicating

1. Make sure you've [created a Notion integration](https://developers.notion.com/docs/getting-started) and have a secret Notion token.
2. Add your Notion token to a `.env` file at the root of this repository: `echo "NOTION_TOKEN=[your token here]" > .env`.
3. Run `npm install`.
4. Edit the `database_id` in `index.ts` from FIXME to be any database currently shared with your integration.
5. Run `npm start` to run the script.

Now you can head over to our [developer documentation](https://developers.notion.com/) for more information on using the Notion API!

## NPM Scripts

This template has a few built-in NPM scripts:

| Script | Action |
| - | - |
| `npm start` | Run `index.ts`. |
| `npm run typecheck` | Type check using the TypeScript compiler. |
| `npm run format` | Format using Prettier (also recommended: the [Prettier VS Code extension](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) if you're using VS code.) |
| `npm run build` | Build JavaScript into the `dist/` directory. You normally shouldn't need this if you're using `npm start`. |
Loading

0 comments on commit 98c58fd

Please sign in to comment.