Express Application for GoBarber project

🌍 Ecosystem

Below the technologies, used to build this API:

Name	Status

💻 Getting started

Start with Run in Insomnia or import the insomnia.json on Insomnia App.

Requirements

• Node.js
• Yarn or npm
• One instance of PostgreSQL
• One instance of Redis
• One instance of MongoDB

Clone the project and access the folder

$ git clone https://github.com/wladimirgrf/gobarber-api.git && cd gobarber-api

Follow the steps below

# Project dependencies
$ yarn

# Make a copy of '.env.example' to '.env'
# and set with YOUR environment variables.
$ cp .env.example .env

# Create the instance of postgreSQL using docker
$ docker run --name postgres -e POSTGRES_PASSWORD={password} -p 5432:5432 -d postgres

# Create the instance of mongoDB using docker
$ docker run --name mongodb -p 27017:27017 -d -t mongo

# Create the instance of redis using docker
$ docker run --name redis -p 6379:6379 -d -t redis:alpine

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

# Start the api service
$ yarn dev:server

🤝 Contributing

Fork the repository

# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.

$ gh repo fork wladimirgrf/gobarber-api

Follow the steps below

# Clone your fork
$ git clone fork-url && cd gobarber-api

# Create a branch for your edits
$ git checkout -b new-feature

# Make the commit with your changes
$ git commit -m 'feat: New feature'

# Send the code to your remote branch
$ git push origin new-feature

After your pull request is merged, you can delete your branch.

📝 License

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