thalesgomest/boardcamp-back

Project Description

Boardcamp is a management system of a board game store!

This is an web application where it is possible to register games, separate them by category, enter customers and manage rents.

Status

Features

• Categories - GET all games categories and insert a new game catogory.

• Games - GET all games registered in the store, insert a new game.

• Customers - GET all clients, GET a client by it's ID, insert a new client and update a client data.

• Rentals - GET all game rentals, insert a rental, conclude a rental and delete a non concluded rental.

Technologies

How to run

1. Clone this repository

git clone https://github.com/thalesgomest/boardcamp-back.git

2. Clone the front-end repository at https://github.com/thalesgomest/boardcamp-front and follow the instructions to run

3. Create a Database into Postgres

4. Set the environment variables by following these steps:

  - 4.1 Create a `.env` file in the folder root
  - 4.2 Copy the content of the `.env.example` into it
  - 4.3 Set the data

5. In your terminal, go back to the root folder and install the dependencies

npm i

6. Also in the root folder, run the back-end with

npm start

7. Your server should be running now.

8. In your terminal, go to the root folder and run the tests with:

npm run test

Author

---

Thales Gomes Targino