Skip to content

Latest commit

 

History

History
101 lines (71 loc) · 2.05 KB

README.md

File metadata and controls

101 lines (71 loc) · 2.05 KB
Raw

Lists

Screenshot

App that keeps 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:

UI:

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):

brew services start postgresql@14
brew services start redis
./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

OPS

The top level directory contains some convenience scripts to help with deploying and spawning remote shells.

  • deploy: Builds and deploys backend and frontend to rathr.io
  • redis: Spawns a redis-cli in the redis container
  • postgres: Spawns a psql shell in the postgres container
  • web: Spawns a shell in the web container

APIs used

Lists relies on the following APIs to scrape meta info: