notion-typescript-api

An unofficial TypeScript wrapper for the Notion API

Prerequisites

Node.JS
Yarn

Installation

git clone [email protected]:notion-hacks/notion-typescript-api.git
npm install

Usage

TODO: Usage

Development

All source code is written in TypeScript.

Testing

Jest is used. TODO: Coverage

Linting/Formatting

Prettier and ESLint have been configured, and can be run with:

npm run lint - outputs the linting errors (is run in pretest)
npm run format - automatically fixes the linting errors where possible

Committing

Commitizen is used to ensure standardized commit messages. Use npm run commit, rather than the traditional git commit.

TODO: Semantic release

CI

TODO: GitHub Actions

Deployment

TODO: Deployment