Start with Express, a framework for NodeJS.

Is a application programming interface - API - to cars rental, was develop to fictitious company called Rentx. It's has some feature:

• User registration
• User authentication and token generation
• Car registration and car-related items such as specifications and categories
• Car rental and return
• User password recovery via email.

Technologies I used this project.

• Node.js
• TypeScript
• Express
• TypeORM
• uuid v4
• Tsyringe
• Bcryptjs
• CSV-Parse
• JSON Web Token
• Multer
• Nodemailer
• Rate Limiter Flexible
• Swagger
• AWS SDK
• Sentry
• dotenv
• Postgres
• Redis
• Docker
• Docker Compose
• Jest
• SuperTest
• Babel
• Eslint
• Prettier
• EditorConfig

To run this backend application in your machine follow some requirement below:

• Node.js
• Yarn ou npm
• Postgres
• Redis

Obs.: I recommend you use the tool Docker Compose

Clone this project and access the folder

$ git clone https://github.com/WalleksMR/rentax.git && cd rentax

Follow step to step below

# Install the dependencies
$ yarn

# Make a copy of .env.example to .env
# and config your database to run locally
# according to the config the file docker-compose.yml

$ cp .env.example .env

# Now run this command below
$ docker-compose up -d

# When the services are running, you should run this command to create the tables in the database
$ yarn typeorm migration:run

# Run your server
$ yarn dev

# Good Job👏, application is running!

# To run the tests, you need create a new database called rentx_test
# and after run the command below
$ yarn test

In software engineering and system engineering, a functional requirement defines a function of a system or its component, where a function is defcribed as a specification of behavior between inputs and outputs. FuncionalRequirement

Access the router http:localhost:3333/api-docs

Este projeto está licenciado sob a licença MIT - Veja Licença para mais detalhes.

Made with ❤️  by Walleks Miranda 👋  See my Linkedin