Uses the Notion SDK Template Repository and TypeScript.
- 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!
- See the documentation for creating a Notion integration and have a secret Notion token.
- Share the newly created integration with the Notion Page or Database to be accessed and record the Database ID.
- See the documentation for the official Todoist REST API. The application needs an authorization header with the appropriate
Bearer $token
to make authorized calls.
During development, the personal API token can be used and is accessed via User Settings > Integrations > API token. - Add Notion token, Todoist token, and Notion Database ID to an
.env
file at the root of this repository.
For example:echo "NOTION_TOKEN=[your token here]" > .env
. - Run
npm install
. - Edit the
database_id
inindex.ts
from FIXME to the Database ID shared with the integration. - Run
npm start
to 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 . |