Setup

Initialize the project

You can choose to fork the template repository or clone the repository to your local.

git clone https://github.com/futantan/notiondir-template.git

If you haven't bought NotionDir yet, get it here: NotionDir

Install dependencies

pnpm install

Run the development server

pnpm dev

Open http://localhost:3000/ in your browser to see the project.

Create your own Notion database

Now, the project is up and running, you can start to configure it to use your own Notion database.

In NotionDir, notion is the data source, you can reuse your existing Notion database or create a new one.

While any database can be used, we recommend to duplicate from the template database. It provides serval reserved fields for NotionDir to work.

Duplicate from the template database

Open the following link to duplicate the template database 👇🏻:

After opening the link, click the "Duplicate" button on the top right to create a new database in your Notion workspace.

After duplicating, please make the page public so that NotionDir can access it with API.

And now, please copy the url to your notion page, we will use it in the next step.

Configure NotionDir to use your notion database

Open the notiondir-template/src/site-config.ts file, and update notionListPageUrl field to the notion page url that you copied in last step.

Try to edit the notion database, you should see the changes in NotionDir now!

Congratulations! You have successfully configured NotionDir.