https://github.com/harryzcy/nodop

Notion Database Operator
https://github.com/harryzcy/nodop

ci nodejs notion notion-api notion-ops ops typescript workflow

Last synced: about 2 months ago
JSON representation

Notion Database Operator

• Host: GitHub
• URL: https://github.com/harryzcy/nodop
• Owner: harryzcy
• License: mit
• Created: 2022-06-13T04:11:03.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-23T16:27:47.000Z (3 months ago)
• Last Synced: 2024-10-24T12:42:26.974Z (3 months ago)
• Topics: ci, nodejs, notion, notion-api, notion-ops, ops, typescript, workflow
• Language: TypeScript
• Homepage:
• Size: 2.02 MB
• Stars: 14
• Watchers: 4
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# nodop - **NO**tion **D**atabase **OP**erator

![Node.js CI](https://github.com/harryzcy/nodop/actions/workflows/nodejs.yml/badge.svg)

![Docker CI](https://github.com/harryzcy/nodop/actions/workflows/docker.yml/badge.svg)

![Lint Code Base](https://github.com/harryzcy/nodop/actions/workflows/linter.yml/badge.svg)

A workflow runner system for Notion databases.

WARNING: There maybe breaking changes before 1.0 release.

## Usage

Use Docker:

```shell

docker run -v PATH/TO/CONFIG/:app/conf/ -v PATH/TO/CACHE/:app/cache/ --env NOTION_KEY= harryzcy/nodop

```

- `PATH/TO/CONFIG/` should point to a directory holding workflow files according to [this syntax](#workflow-syntax).

- `PATH/TO/CACHE/` (optional) should point to a directory for cache

  If enabled, timestamp of the last runtime will be stored, so when Docker is restarted, it can catch up from last timestamp.

- `NOTION_KEY` should be obtained by creating your own [Notion integration](https://www.notion.so/my-integrations).

## Build

```shell

npm run build:release

npm run daemon

```

## Workflow Syntax

Please refer to [workflows doc](docs/workflows.md) or [examples](./examples/)

## Additional Configurations

The configurations below are available via environment variables.

### `CONFIG_PATH`

The path to configuration directory or file.

### `CHECK_INTERVAL`

The interval in seconds that Notion database changes will be checked.

Default: 30

### `LOG_FILE`

The path of the log file. If left empty, the log will be outputted to console.