enfayz / Nishan

Unofficial Notion api for typescript with all crud functionalities for Space, User, Block, Page and many more

Nishan

Unofficial Notion api for node.js with all crud functionalities for Space, User, Block, Page and many more.

This monorepo contains/will contain the following packages:-

Legend

1. NPM: Packages released in npm
2. WIP: Packages under heavy construction
3. NSY: Package development not started yet

Packages

1. @nishans/core Github NPM Docs: Core package for nishan with all crud api
2. @nishans/types Github NPM Docs: Typescript typings for Notion only
3. @nishans/utils Github NPM Docs: Utility package to make working with notion easier
4. @nishans/sync Github NPM Docs: A package to keep remote notion data in sync with local data stored in mongodb or in a file, by downloading remote data locally and restoring notion using local data.
5. @nishans/graphql Github (NSY): A graphql server and client UI to make working with nishan a breeze
6. @nishans/cli Github (NSY): A package to interact with the nishan api from the terminal
7. @nishans/typegen Github (NSY): A package to automatically generate typescript definitions from a remote notion collection schema
8. @nishans/orm Github (NSY): A package to use notion as a database by providing an easy to use orm api
9. @nishans/endpoints Github NPM Docs: A package to expose all notion endpoints for queries and mutations
10. @nishans/react-filters Github (WIP): A react component that emulates notions advanced filter
11. @nishans/markdown Github (WIP): A package to upload markdown content into notion
12. @nishans/remark-notion Github (WIP): A remark plugin to support custom notion specific syntax for @nishans/markdown package
13. @nishans/discord-bot Github (NSY): A general purpose discord bot for working with @nishans/core from the discord chat textbox
14. @nishans/notion-formula Github NPM Docs: A package to generate notion formula with ease
15. @nishans/schema-builder Github (NSY): A package to create notion collection schema painlessly

Apps

A few apps built using the above packages

1. markdown-web (NSY): A react powered web app to upload markdown content as notion pages using @nishans/markdown
2. markdown-desktop (NSY): An electron powered desktop app to upload markdown content as notion pages using @nishans/markdown
3. markdown-vscode (NSY): A vscode extension to upload markdown content as notion pages using @nishans/markdown
4. markdown-native (NSY): A react native powered mobile app to upload markdown content as notion pages using @nishans/markdown
5. notion-formula-web (NSY): A react powered web app to view the generated notion formula ast from array, object or string representation using @nishans/notion-formula package

NOTE: The name of the package was originally named nishan, but unfortunately that name was already taken in npm. I'll use the term nishan everywhere except in case of the package names, where its nishans.

Each package has its own docs and examples folder, please feel free to examine them to learn more about each one.

Contributors

1. Safwan Shaheer github Author, Maintainer
2. Matt Casey github Contributor

How to contribute

1. Clone the repo locally by typing git clone https://github.com/Devorein/Nishan.git on the terminal.
2. Make sure you have yarn installed
3. Install all the dependencies using yarn install.
4. Run all the tests using yarn test.

Feel free to submit a pull request or open a new issue, contributions are more than welcome !!!

Implementations in other languages

1. Python: notion-py
2. Go: notionapi
3. Ruby: notion-ruby
4. Kotlin: notion-sdk-kotlin