Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andrecrjr/notion-graph-view
Notion Pages as Graphs like-obsidian to improve learning/studies, open source mode.
https://github.com/andrecrjr/notion-graph-view
api d3 docker graph graph-mode learning mental mind next nextjs14 nodejs nodes notion obsidian portfolio server view
Last synced: about 2 months ago
JSON representation
Notion Pages as Graphs like-obsidian to improve learning/studies, open source mode.
- Host: GitHub
- URL: https://github.com/andrecrjr/notion-graph-view
- Owner: andrecrjr
- License: apache-2.0
- Created: 2024-08-23T02:37:55.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-09-22T19:17:07.000Z (3 months ago)
- Last Synced: 2024-11-07T06:54:15.358Z (about 2 months ago)
- Topics: api, d3, docker, graph, graph-mode, learning, mental, mind, next, nextjs14, nodejs, nodes, notion, obsidian, portfolio, server, view
- Language: TypeScript
- Homepage: https://graph-mode.vercel.app
- Size: 253 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Notion Graph Viewer
This project provides a Next.js-based front-end that displays Notion pages in a graphical view. The application requires setting up a backend server alongside the front-end for full functionality.
## Technologies
- **Node.js**: JavaScript runtime built on Chrome's V8 JavaScript engine.
- **Next.js**: A React framework for building server-side rendering and static web applications.
- **Tailwind CSS**: A utility-first CSS framework for rapidly building custom designs.
## Prerequisites
Before you begin, ensure you have Node.js(NVM) and Make, installed on your system. This project uses make and pnpm and Notion for managing dependencies and scripts, so make sure these tools are also installed. You'll need a Notion Integration to fill the `.env` for front-end mainly.
### Notion Integration
To integrate Notion with this project, create a Notion integration and note down the integration token. You'll need to fill up in the `.envs`:
[Link to create a Notion Integration](https://www.notion.so/profile/integrations)
### Install Make and PNPM
You can install make and pnpm using the following commands:
```bash
sudo apt-get install make
npm install -g pnpm
```
### Docker
Using Docker is optional, but it simplifies the setup process. You can just install the dependencies by yourself using following command:
```bash
make install_deps
```
### Setting Up Environment Variables (Required)
Duplicate the .env.example file for both the Server and Front-end projects. Rename the duplicated files to .env and fill in with your own data.
## Getting Started
You'll need to have Make installed to run it easier, but you can run by yourself using docker composes.
Following commands:
```bash
# Download all pnpm packages and up all containers
make run-all
# Run only the containers
make run-dev
# Install only dependecies
make install-all-deps
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the front-end.