Skip to content

Latest commit

 

History

History
50 lines (34 loc) · 1.5 KB

README.md

File metadata and controls

50 lines (34 loc) · 1.5 KB
Raw

watch-jcb

Notify new campaign information added to the JCB Card campaign list page via Discord.

Installation

Works in Node.js or Docker (Compose) environment.

Docker (Recommended)

If you want to use Docker, write the following in docker-compose.yml:

version: '3.8'
services:
  app:
    image: ghcr.io/tomacheese/watch-jcb:latest
    volumes:
      - type: bind
        source: ./data
        target: /data/
    init: true
    restart: always

After that, you can start it with docker-compose up -d after creating a configuration file with reference to Configuration section.

Node.js

If you are running in a Node.js environment, Node.js v18 is recommended.

Download and extract watch-jcb_vX.Y.Z.zip from the release page in the latest release.
After that, you can start it with node index.js after creating a configuration file with reference to Configuration section.

Configuration

The configuration file data/config.json is used by default.
If the environment variable CONFIG_FILE is set, the specified value is taken as the path to the configuration file.

See here for the JSON Schema of the configuration file: schema/Configuration.json

{
  "$schema": "https://raw.githubusercontent.com/tomacheese/watch-jcb/master/schema/Configuration.json"
}

License

The license for this project is MIT License.