Rentx

Technologies • Getting started • License

🚀 Technologies

• TypeScript
• Express
• Multer
• TypeORM
• JSON Web Token
• PostgreSQL
• Jest
• SuperTest
• Sentry

💻 Getting started

Import the Insomnia.json on Insomnia App

Requirements

• Node.js
• Yarn or npm
• Docker and Docker Compose

Clone the project and access the folder

git clone https://github.com/PaulosSouza/rentx.git && cd rentx

Follow the steps below

# Install the dependencies
$ yarn

# Make a copy of '.env.example' to '.env'
# and set with YOUR environment variables.
# The aws variables do not need to be filled for dev environment
$ cp .env.example .env

# Start all the services and the application with Docker Compose
$ docker-compose up -d

# Once the services are running, run the migrations
$ yarn migration:run

# Run the seeds
$ yarn seed:run

# To finish, run the api service
$ yarn dev

# Well done, project is started!

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Made by Paulo Henrique 🎸