Go Barber API

Manage you Barbershop with this API!
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgements

About The Project

Manage you Barbershop with this API

Features:

• Route to authenticate a provider

• Route to register a new provider

• Route to show a provider's profile

• Route to update a provider's avatar

• Route to update a provider's profile

• Route to forgot a password

• Route to reset a password

• Route to create an appointment

• Route to list the day availability

• Route to list the month availability

• Route to list the providers

• Route to list the providers' appointments

Built With

• Node JS
• TypeScript
• Express JS
• Docker
• TypeORM
• PostgreSQL
• MongoDB
• Redis
• Bcryptjs
• Handlebars
• Nodemailer
• AWS SDK
• Celebrate
• JSON Web Token
• Tsyringe
• Multer
• Reflect Metadata

Getting Started

Prerequisites

• npm

  npm install npm@latest -g

• yarn

  npm install --global yarn

• docker

Installation

1. Clone the repo

   git clone https://github.com/jennifertakagi/go-barber-api.git

2. Install packages

   yarn | npm install

3. Create a Postgress docker image with the following command and options:

docker run --go-commerce foo -e POSTGRES_PASSWORD=docker -p 5432:5432 -d postgres

4. Create a MongoDB docker image with the following command and options:
```sh
docker run --name mongodb -p 27017:27017 -d -t mongo

5. Create a Redis docker image with the following command and options:

docker run --name redis -p 6379:6379 -d -t redis:alpine

6. Run database migrations
```sh
yarn typeorm migration:run | npm run typeorm migration:run

7. Run the local environment

yarn dev:server | npm run dev:server

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Jennifer Takagi - @jennitakagi

Acknowledgements

• Jest
• ESLint
• Prettier