rathrio/lists

Tracking recommendations (movies, TV shows, games, books, ...)

Lists

Lists to keep track of movies, TV shows, games, books and various other things. This project exists because I'd rather manage these in one self-hosted location instead of multiple third-party services, such as Letterboxd, Goodreads or the Steam Library.

Prerequisites

API:

• Ruby >= 2.6
• Bundler
• PostgreSQL >= 13
• Redis
• Imagemagick >= 7

UI:

• Node >= 16
• Yarn

Ensure that postgres and redis servers are running (listening to default ports).

Installation

API (cd api):

1. Install dependencies:

   bundle install
   yarn install

2. Setup database:

   ./bin/rails db:setup

3. Apply migrations:

   ./bin/rails db:migrate

UI (cd ui):

1. Install dependencies:

   yarn install

Running

API (cd api):

./bin/rails server

UI (cd ui):

yarn start

Then visit http://localhost:3001.

Running tests

API (cd api):

./bin/rails test

UI (cd ui):

yarn test

Contributing

1. Fork this repository

2. Create your feature branch git checkout -b my-new-feature

3. Commit your changes git commit -am "Add some feature"

4. Push to the branch git push origin my-new-feature

5. Run tests

   # in api/
   ./bin/rails test
   
   # in ui/
   yarn test

6. Create new Pull Request (in your forked repository)

API Credits

Lists relies on the following APIs to scrape meta info:

• Movies / TV Shows: The Movie DB
• Video Games: IGDB
• Books: Google Books
• Recipes: Edaman