https://github.com/gptscript-ai/knowledge-notion-integration
https://github.com/gptscript-ai/knowledge-notion-integration
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/gptscript-ai/knowledge-notion-integration
- Owner: gptscript-ai
- Created: 2024-08-29T21:10:48.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-16T22:15:58.000Z (over 1 year ago)
- Last Synced: 2024-09-18T00:37:10.833Z (over 1 year ago)
- Language: TypeScript
- Size: 70.3 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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`. |