viniciusbe / go-barber-api

REST API made during the GoStack bootcamp, using Express.js

RESTful api used by GoBarber web and mobile applications

🌙 Routes

📝 Table of Contents

• About
• Getting Started
• Built Using
• License
• Authors

🧐 About

This project was created during the RocketSeat's bootcamp GoStack

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

What things you need to install the application.

Node.js
Yarn
PostgreSQL, MongoDB, Redis 
Docker (Optional - Recommended)
VS Code (Optional - Recommended)

Installing

A step by step series of examples that tell you how to get a development env running.

Create an instance for each database on docker, following this example for postgres : https://hub.docker.com/_/postgres.

Cloning the repository:

git clone https://github.com/viniciusbe/GoBarber-api

Enter the app folder:

cd GoBarber-api

Install the dependencies and create your .env (don't forget to create a strong secret to APP_SECRET variable):

yarn
cp .env.example .env

Run the migrations and finally run the application:

yarn typeorm migration:run
yarn dev:server

The application will run on http://localhost:3333/

You can test all the routes on Insomnia, just install it and import my workspace

⛏️ Built Using

• Express
• PostgreSQL
• MongoDB
• Redis
• Celebrate
• Bcryptjs
• Date-fns
• Handlebars
• Multer
• Typeorm

✍️ License

This project is made available under the MIT License

Authors

Made with ❤ by Vinícius Bernardes