Skip to content

mathmelo/GoBarber-NodeJS

Repository files navigation

GoBarber

🚀 Appointment Management API for Barber Services

NPM NPM NPM NPM



💡 Objective

The main purpose of this API is to connect service providers (barbers) to their customers, so they can more easily manage their appointments.

Basically, the API allows both types of users to register in the system. Barbers will be responsible for managing appointments and clients will be responsible for choosing and hiring a preferred barber.

Check the WEB version

Check the MOBILE version

🎌 Roadmap

Prerequisites

Before starting, you will need to have the following tools installed on your machine:

You can also use npm, but we seriously recommend yarn.

Also it's nice to have an editor to work with the code like VSCode.

Running the Back End (server)

To execute these commands, you will need to create 3 containers in the docker

🚫 Important

  • A .env file must be created in the project's root folder containing all access keys, including to the databases.
  • The .env.exemple file can be used as an example

Execute the commands

# Clone this repository
$ git clone https://github.com/mathmelo/GoBarber-NodeJS

# Access the project folder in the terminal/cmd
$cd GoBarber-NodeJS

# Install dependencies
$ yarn

# Run migrations
$ yarn migrate

# Run the application in development mode
# The application must run on two nodes. If you are using VsCode, just open a terminal for each of these commands
$ yarn queue
$ yarn dev

# The server will start on port:3335 - go to <http://localhost:3335>

💜 Technologies

  • Javascript
  • NodeJS
  • Express
  • Postgres, MongoDB and Redis
  • Sequelize
  • Sentry
  • Nodemailer
  • JWT

📕 License

Read the license here.

🤓 Author

Informations about me. Send me a message! ;)

🚧 GoBarber 🚀 In construction... 🚧
Building docs