https://github.com/utkuufuk/goodreads-service
Goodreads service for entrello
https://github.com/utkuufuk/goodreads-service
Last synced: 7 months ago
JSON representation
Goodreads service for entrello
- Host: GitHub
- URL: https://github.com/utkuufuk/goodreads-service
- Owner: utkuufuk
- Created: 2022-04-17T20:18:27.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-05-06T18:36:54.000Z (over 3 years ago)
- Last Synced: 2025-01-29T07:48:40.561Z (9 months ago)
- Language: TypeScript
- Homepage:
- Size: 246 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# goodreads-service
[](https://github.com/utkuufuk/goodreads-service/actions/workflows/ci.yml)
A simple service to poll an RSS feed, e.g. the contents of a shelf, from [Goodreads](https://www.goodreads.com). Can be used as a data source for [`entrello`](https://github.com/utkuufuk/entrello).
## Development
Create a `.env` file in the project root directory based on `.env.example`.
```sh
# 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](https://github.com/utkuufuk?tab=packages&repo_name=goodreads-service) will be created upon each [release](https://github.com/utkuufuk/goodreads-service/releases).
1. Authenticate with the GitHub container registry (only once):
```sh
echo $GITHUB_ACCESS_TOKEN | docker login ghcr.io -u GITHUB_USERNAME --password-stdin
```
2. Pull the latest Docker image:
```sh
docker pull ghcr.io/utkuufuk/goodreads-service/image:latest
```
3. Start the server:
```sh
docker run -d \
-p : \
--env-file \
--restart unless-stopped \
--name goodreads-service \
ghcr.io/utkuufuk/goodreads-service/image:latest
```