This is a template repository for getting started with the Notion SDK and TypeScript.
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.
- TypeScript for type checking.
- Prettier for code formatting.
- A minimal GitHub Actions workflow that typechecks your code.
- Dotenv for configuring your Notion API token.
- Dependabot for ensuring your (and this template's!) dependencies are up to date.
- Our lovely Notion SDK!
- Make sure you've created a Notion integration and have a secret Notion token.
- Add your Notion token to a
.envfile at the root of this repository:echo "NOTION_TOKEN=[your token here]" > .env. - Run
npm install. - Edit the
database_idinindex.tsfrom FIXME to be any database currently shared with your integration. - Run
npm startto run the script.
Now you can head over to our developer documentation for more information on using the Notion API!
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 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. |
![@dependabot[bot]](https://avatars.githubusercontent.com/in/29110?s=64&v=4){kind=small}