BrunoSSantana/devchallenge_biblioteca_api

Biblioteca Backend - DevChallenge

About the project | Technologies | Getting started | License | References

👨🏻‍💻 About the project

Repository created from the biblioteca-backend challenge made in by the DevChallenge community.

🚀 Technologies

Technologies that I used to develop this api

💻 Getting started

Import the Insomnia.json on Insomnia App or click on

Requirements

Node.js
Yarn or npm
One instance of PostgreSQL

Clone the project and access the folder

Clone by HTTPS:

$ git clone https://github.com/BrunoSSantana/devchallenge_biblioteca_api.git && cd devchallenge_biblioteca_api

Clone by GitHub CLI:

$ gh repo clone BrunoSSantana/devchallenge_biblioteca_api

Follow the steps below

Backend

# Install the dependencies
$ yarn

# Create the instance of postgreSQL using docker
$ docker run --name project-postgres -e POSTGRES_USER=docker \
              -e POSTGRES_DB=project -e POSTGRES_PASSWORD=docker \
              -p 5432:5432 -d postgres

# Make sure the keys in '.env' to connect with your database
# are set up correctly.

# Once the services are running, run the migrations
$ yarn typeorm migration:run

# To finish, run the api service
$ yarn dev

# Well done, project is started!

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

BrunoSSantana / devchallenge_biblioteca_api