collection-log-api

Serverless API for collectionlog.net and the collection log Runelite plugin

Getting started

Clone the respository and install dependiencies

$ git clone https://github.com/evansloan/collection-log-api && cd collection-log-api
$ yarn install

Docker setup

1. Create .env file

Rename .env.docker to .env. The variables in this file can be modified to your liking

2. Build and start the Docker container

$ docker-compose up

3. Apply database migrations

$ docker-compose exec api yarn run migrate:latest

4. Run database seeders (optional)

$ docker-compose exec api yarn run seed

5. Connect to the database and API

Database connection string: postgres://postgres:postgres@localhost:5433/collection_log

API base URL: http://localhost:3001/

Manual setup

1. Install PostgreSQL

2. Set up collection_log database and user

$ createuser <username>
$ createdb collection_log
$ psql
$ ALTER USER <username> WITH encrypted password '<password>'
$ GRANT ALL PRIVILEGES ON DATABASE collection_log TO <username>

3. Create .env file

Rename .env.sample to .env and set the following variables

DB_USER=<username>
DB_PASS=<password>

4. Apply database migrations

$ yarn run migrate:latest

5. Run database seeders (optional)

$ yarn run seed

6. Run the API

yarn run dev

7. Connect to the database and API

Database connection string: postgres://postgres:postgres@localhost:5433/collection_log

API base URL: http://localhost:3001/

Documentation