https://github.com/samuraikun/export_github_to_notion
Tool to export from Github Issue & Pull-requests to Notion
https://github.com/samuraikun/export_github_to_notion
github-graphql-apiv4 notion-api typescript
Last synced: 7 months ago
JSON representation
Tool to export from Github Issue & Pull-requests to Notion
- Host: GitHub
- URL: https://github.com/samuraikun/export_github_to_notion
- Owner: samuraikun
- Created: 2023-07-29T20:43:27.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-04T06:32:08.000Z (about 2 years ago)
- Last Synced: 2025-01-22T12:12:57.214Z (9 months ago)
- Topics: github-graphql-apiv4, notion-api, typescript
- Language: TypeScript
- Homepage:
- Size: 18.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# export_github_to_notion
This project exports GitHub issues and pull requests data to Notion.
## Prerequisites
- Docker and Docker Compose installed on your machine.
- Visual Studio Code with the Remote - Containers extension installed.
### Notion API & Database Setup
1. Create a new Notion integration at https://www.notion.com/my-integrations.
2. Copy the integration's `Internal Integration Token` and save it for later.
3. Create a new Notion database at https://www.notion.so/help/guides/creating-a-database
4. Add Notion API token and database ID to `.env` file like below.
```bash
OWNER=xxx
REPO=xxx
GITHUB_TOKEN=xxx
NOTION_TOKEN=xxx
NOTION_DATABASE_ID=xxx
```
## Project Setup
1. Clone this repository.
2. Open the repository in Visual Studio Code.
3. When prompted to "Reopen in Container", click "Reopen in Container". This will start the Docker container and set up your development environment.
- If you don't see the prompt, press `F1` to open the command palette, and then select "Remote-Containers: Reopen in Container".
4. Once the container is running, you can start working with the project.
## Project Structure
- `src/`: This is where your TypeScript (.ts) source files live. This directory could be organized further depending on the project's requirements.
- `dist/`: This is where the compiled JavaScript will be output to by the TypeScript compiler.
- `node_modules/`: This directory is where pnpm stores installed packages.
- `.devcontainer/`: This directory contains configuration files for the Visual Studio Code Remote - Containers extension.
- `package.json` and `pnpm-lock.yaml`: These files are used by pnpm to track your project's dependencies.
- `tsconfig.json`: This file is used by TypeScript to control the behavior of the TypeScript compiler.
## How to Use
### Run VSCode Remote Container
1. Open the repository in Visual Studio Code.
2. When prompted to "Reopen in Container", click "Reopen in Container". This will start the Docker container and set up your development environment.
- If you don't see the prompt, press `F1` to open the command palette, and then select "Remote-Containers: Reopen in Container".
### Install Dependencies
```bash
pnpm install
```
### Build
```bash
pnpm run build
```
### Run
```bash
pnpm run start
```