Boardcamp API

The API for Boardcamp, a system to manage rentals of a board games store.

The front-end repository can be found here

Implemented features

• Add and list categories, games and customers
• Update some of the customers informations
• Rent a game to a customer
• Return or delete a rent
• Extras on the back-end repository: paging, sorting and filtering the lists by some param

Technologies

How to run

1. Clone this repository

git clone git@github.com:acolima/boardcamp-api.git

2. Go to the project directory

 cd boardcamp-api

3. Install dependencies

npm i

4. Go to the database directory and run

cd database
bash ./create-database
cd ..

5. Create a .env file with the same structure of .env.example and change the values of the enviroment variables

DATABASE_URL={POSTGRES CONNECTION STRING}
PORT={PORT THAT YOU HAVE SETTLED}

6. Run project with

npm run dev

Author