๐ธ Techsย ย ย ย |ย ย ย
๐ Techs ๐ธ
This project was developed at the RocketSeat GoStack Bootcamp 11 with the following technologies:
- AWS SDK
- Bcrypt.js
- Cors
- Celebrate
- Date-fns
- Express
- Handlebars
- Jest
- JSON Web Tokens - JWT
- MongoDB
- Multer
- NodeJS
- Nodemailer
- Redis
- TypeORM
- TSyringe
- TypeScript
- Uuidv4
- VS Code with ESLint, EditorConfig & Prettier
๐ 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.
๐ 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! ;)
๐ Badges ๐
๐ License ๐
Copyright ยฉ 2021 GoBarber, MIT .
โAlways running in search of the goals!โ
Done with โฅ by myself ๐ Get in touch!