You need the following in order to run this API:
- Nodejs & npm
- Postgresql
Clone this repo and install packages via npm.
npm install
cp .env.example .env #create .env from example
nano .env #enter your database info & save
Create DB tables, and optionally run seed script:
npx prisma db push
npx prisma db seed #optional
Starting API server, you can define port at .env file. Default port is 3000.
npm run start
To run fetcher, run the following command:
npm run fetcher
Check out API docs here.
You can run this API in Docker containers with minimal effort as follows:
Install docker and docker composer from https://www.docker.com
from the project folder execute:
docker compose up -d
A database with some seed data, the Api Serve and the Fetcher Server will be deployed.