lucascprazeres / rentx Goto Github PK

RentX is a nodejs REST API developed on a back-end bootcamp called Ignite. It is platform for renting sports cars which allows you to manage your vehicles, it's features and, of couse, their rents!

Since it's an Open source project, feel free to make your contributions to help make this application a really nice thing :)

• Typescript - Main language
• Nodejs - Runtime environment
• Multer - File upload middleware
• Expressjs - Web server
• Swagger UI - API documentation

fork this repository on your github

then, use your terminal to clone your fork to your local machine

$ git clone <your-fork-url>
$ cd rentx
$ yarn

Some app commands

$ yarn dev # run development code
# $ yarn test # run tests (not implemented yet...)
# $ yarn build # creates a javascript build (not implemented yet...)
# $ yarn start # run build code (not implemented yet...)

make sure to complete the steps on the previous sections

then,

# create a branch to wrap your changes
$ git checkout -b <your-branch-name>

# write some code...

# commit your chages
git add . && git commit -m "type(scope): description"

# send them to your fork
git push origin <your-branch-name>

the last step is to create a pull request here on github

ps: if you're not familiar with the commit message structure above, please check this

The API endpoints are well documented on the swagger interface. To check it, just run the api and access

http://localhost:3333/api-docs

This project is under the MIT License. Read the LICENSE file for further information.