Skip to content

Commit 80f6530

Browse files
committed
CI and starting README
1 parent 19621d6 commit 80f6530

3 files changed

Lines changed: 44 additions & 0 deletions

File tree

.github/workflows/ci.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
env:
10+
NODE_VERSION: 16.x
11+
12+
jobs:
13+
build-and-test:
14+
runs-on: ubuntu-latest
15+
16+
steps:
17+
- uses: actions/setup-node@v3
18+
with:
19+
node-version: ${{ env.NODE_VERSION }}
20+
- uses: actions/checkout@v3
21+
- run: |
22+
npm install
23+
npm run typecheck

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
node_modules
22
dist
3+
.env

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# notion-sdk-typescript-starter
2+
3+
This is a template repository for getting started with the [Notion SDK](https://github.com/makenotion/notion-sdk-js)
4+
and [TypeScript](https://www.typescriptlang.org/).
5+
6+
## Features
7+
8+
- TypeScript for type checking.
9+
- Prettier for code formatting.
10+
- A minimal GitHub Actions workflow that typechecks your code.
11+
- Dotenv for configuring your Notion API token.
12+
- Our lovely Notion SDK!
13+
14+
## What to do after duplicating
15+
16+
1. Make sure you've [created a Notion integration](https://developers.notion.com/docs/getting-started) and have a secret Notion token.
17+
2. Add your Notion token to a `.env` file at the root of this repository: `echo "NOTION_TOKEN=[your token here]" > .env`.
18+
3. `npm install`.
19+
4. Edit the `page_id` in `index.ts` from FIXME to be any page currently shared with your integration.
20+
5. `npm start` to run the script.

0 commit comments

Comments
 (0)