Skip to content

๐Ÿ’ˆ GoBarber api back-end, project intended to offer scheduling barber shop services.

License

Notifications You must be signed in to change notification settings

caiohenrique-developer/node-deploy

Repository files navigation

๐Ÿ’ˆ GoBarber api, a project developed to offer barber shop scheduling.

๐Ÿ›ธ Techsย ย ย ย |ย ย ย  โš ๏ธ Prerequisitesย ย ย ย |ย ย  โ” How To Useย ย ย ย |ย ย ย  ๐Ÿ”– Badgesย ย ย ย |ย ย ย  ๐Ÿ” Licenseย ย ย ย |ย ย ย  โ˜Ž Contact Me


GoBarber mockup image

๐Ÿ” Techs ๐Ÿ›ธ

This project was developed at the RocketSeat GoStack Bootcamp 11 with the following technologies:

๐Ÿ” Prerequisites โš ๏ธ

In order to use and test this project locally, you should've already setup the development environment.
Therefore, firstly i recommend that you install Docker on your machine and download the images postgres, mongo and redis following the steps in the section on the page How to use this image. Or you can also just follow the steps in the "โ” How To Use" section of this doc.
Or go to gobarber.desenvolvendosistemas.dev.br to see the project in a production environment.

  • Insomnia request routes:
    Run in Insomnia}

๐Ÿ” How To Use โ”

To clone and run this application locally, you'll need Git, Node.js v10.16 or higher + Yarn v1.13 or higher installed on your computer.

Hit me to toggle collapse: ๐Ÿ•น๏ธ๐Ÿค

From your command line follow these steps...

  # Clone the project
  $ git clone https://github.com/caiohenrique-developer/node-deploy 'GoBarber API' && cd 'GoBarber API'

  # Install dependencies
  $ yarn
  # or
  $ npm i

  # Install PostgreSQL image
  # Maybe you must be use the sudo command
  $ docker run --name your-container-name \
  		-e POSTGRES_USER=your-username \
  		-e POSTGRES_DB=your-database \
  		-e POSTGRES_PASSWORD=your-secret-password \
  		-p 5432:5432 \
  		-d postgres

  # Install MongoDB image
  $ docker run --name your-container-name -p 27017:27017 -d -t mongo

  # Install Redis image
  $ docker run --name your-container-name -p 6379:6379 -d -t redis:alpine

  # Copy the files
  # Replace in the (..._TYPE, ..._HOST, ..._PORT, ..._USER, ..._PASS, ..._DB) variables with the values of the images you downloaded for the Postgres, Mongo and Redis containers, on .env file generated
  $ cp .env.example .env && cp ormconfig.example.js ormconfig.js

  # Run the migrations in order to create the database schema
  $ yarn typeorm migration:run

  # Start the project
  $ yarn dev:server

  # Very well, now you can enjoy this project! ;)
  • See also: ๐Ÿ•น๏ธ๐Ÿค

    WEB

    GoBarber front-end repository

    MOB

    GoBarber app mobile repository

GoBarber background image

๐Ÿ” Badges ๐Ÿ”–

GitHub Language Count GitHub Top Language Codacy Grade GitHub Last Commit GitHub Releases GitHub Tags Repository issues Repository Size GitHub License semantic-release

๐Ÿ” License ๐Ÿ”

Copyright ยฉ 2021 GoBarber, MIT .

This project is under the MIT license. See the license for more information.

โ€œAlways running in search of the goals!โ€
Done with โ™ฅ by myself ๐Ÿ‘‡ Get in touch!

๐Ÿ” Contact Me โ˜Ž๏ธ

Profile Avatar
LinkedIn Gmail Whatsapp