API for Rentx

About the project   |    Technologies   |    Getting started   |    How to contribute   |    License

🏎️ About the project

This api provides everything you need to organize car rentals between car rental companies and customers.

Customers can choose the best vehicle available to them on specific days.

💻🛠 Technologies

Technologies that I used:

• TypeScript
• Node.js
• Express
• Multer
• TypeORM
• JWT-token
• uuid v4
• PostgreSQL
• Redis
• Date-fns
• Jest
• Eslint
• Prettier
• EditorConfig

💻🖥 Getting started

Requirements

• Node.js
• Yarn or npm
• Instances of PostgreSQL and Redis

$ git clone https://github.com/leomoraiscam/rentalx-backend.git && cd rentalx-backend-main

Follow the steps below

# Install the dependencies
$ yarn
# Make a copy of '.env.example' to '.env'
# and set with YOUR environment variables.
$ cp .env.example .env
# Create and start containers of postgreSQL and redis using docker
$ docker-compose up -d
# Make a copy of 'ormconfig.example.json' to 'ormconfig.json'
# and set the values, if they are not filled,
# to connect with docker database containers
$ cp ormconfig.example.json ormconfig.json
# Once the services are running, run the migrations
$ yarn typeorm migration:run
# Well done, project is started!

🤔 How to contribute

Make a fork of this repository

# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.
$ gh repo fork leomoraiscam/rentalx-backend

Follow the steps below

# Clone your fork
$ git clone your-fork-url && cd rentalx-backend
# Create a branch with your feature
$ git checkout -b my-feature
# Make the commit with your changes
$ git commit -m 'feat: My new awesome feature'
# Send the code to your remote branch
$ git push origin my-feature

📝 License

This project is licensed under the MIT License

---

Made with 💛 by 👨‍💻Leonardo Morais