This project is a web application that automatically generates documentation for your Notion databases. Provide a Notion Page ID, and the application will fetch all the databases on that page and display their schema, including properties, formulas, and relations.
- Clone the repository:
git clone https://github.com/your-username/your-repo-name.git
- Navigate to the project directory:
cd automated-doc-notion-api
- Install the dependencies:
npm install
- Create a
.env
file in the root of the project and add your Notion API key:NOTION_API_KEY=your_notion_api_key
- Start the application:
npm start
- Open your browser and go to
http://localhost:3000
. - Enter the Notion Page ID of the page containing the databases you want to document and click "Generate".
- @notionhq/client: Official Notion API client
- cookie-parser: Parse cookie header and populate
req.cookies
- debug: A tiny JavaScript debugging utility
- dotenv: Loads environment variables from a
.env
file - ejs: Embedded JavaScript templating
- express: Fast, unopinionated, minimalist web framework for Node.js
- http-errors: Create HTTP errors for Express, Koa, etc.
- morgan: HTTP request logger middleware for node.js