Skip to content

Latest commit

 

History

History
51 lines (38 loc) · 1.37 KB

README.md

File metadata and controls

51 lines (38 loc) · 1.37 KB
Raw

goodreads-service

CI

A simple service to poll an RSS feed, e.g. the contents of a shelf, from Goodreads. Can be used as a data source for entrello.

Development

Create a .env file in the project root directory based on .env.example.

# install dependencies
yarn

# run tests
yarn test

# lint
yarn lint

# build
yarn build

# poll the RSS feed
yarn start poll

# start web server
yarn start serve

Running With Docker

A new Docker image will be created upon each release.

  1. Authenticate with the GitHub container registry (only once):

    echo $GITHUB_ACCESS_TOKEN | docker login ghcr.io -u GITHUB_USERNAME --password-stdin

  2. Pull the latest Docker image:

    docker pull ghcr.io/utkuufuk/goodreads-service/image:latest

  3. Start the server:

    docker run -d \
    -p <PORT>:<PORT> \
    --env-file </absolute/path/to/.env> \
    --restart unless-stopped \
    --name goodreads-service \
    ghcr.io/utkuufuk/goodreads-service/image:latest