Skip to content

Latest commit

 

History

History
140 lines (97 loc) · 3.13 KB

README.md

File metadata and controls

140 lines (97 loc) · 3.13 KB

Technologies Used   |    How to run the API   |    How to contribute   |    License

PRs welcome! License License


📚 About

It's an API that makes appointments for a barber shop.

Services:

  • Create user
  • Read user
  • Reset password
  • Forgot password
  • Create session user
  • Create appointment
  • Read appointements
  • Read static files
  • Change avatar


⚒️ Technologies Used

  • JWT
  • Jest
  • Multer
  • Docker
  • Node.js
  • Express
  • TypeORM
  • Postgres
  • Bcryptjs
  • Ethereal
  • TypeScript


🚀 How to run the API


🔸 Requirements


🔸 Commands

  • Clone this repository
git clone https://github.com/RuthMaria/GoBarber-backend.git
  • Install the postgres image on your docker container using port 5432 or another port
docker run --name gostack_postgres -e POSTGRES_PASSWORD=docker -p 5432:5432 -d postgres
  • Start postgres image
docker start gostack_postgres
  • Open the Dbeaver and create a new connection with Postgres. Change the port to 5432 and in the password, you type "docker", as you have defined above when create a postgres image on docker.

  • After that, create a new database in your postgres connection inside Dbeaver. Write "gostack_gobarber" in the database name.

  • Install dependencies

yarn
  • Create the migrations
yarn typeorm migration:run
  • Run the API
yarn dev:server
  • Run the tests
yarn test

🎯 How to contribute

  • Fork this repository,
  • Create a branch with your feature: git checkout -b my-feature
  • Commit your changes: git commit -m 'feat: My new feature'
  • Push your branch: git push origin my-feature


📝 License

This project is under the MIT license. See the file LICENSE for more details.


Developed with ❤️ by Ruth Maria