Skip to content

A platform to you rent a car. Did using Typescript and NodeJs, just to pratice.

License

Notifications You must be signed in to change notification settings

denis2710/rentx

Repository files navigation

Forks Stargazers Issues Licence LinkedIn


Logo

Rentx

A project of a rent car. Made just to pratice Typescript and NodeJs
Explore the docs »

View Demo (commming soon) · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

This is a project made with Typescript and NodeJs. I make this project following the RocketSeat Ignite Courese. The proposal is to use all tecnology necessary to delivery a API to a rent car interprize.

(back to top)

Built With

(back to top)

Getting Started

Here are the instructions to you run the project in your computer.

Prerequisites

You should have Docker installed in your computter to run this project.

  • in terminal you just need to run the following command
    docker-compose up

(back to top)

Usage

This is a non authenticated api, so you just have to use a software like Postman or Insomnia to do the requests

For more examples, please refer to the Documentation (comming soon)

(back to top)

Roadmap

  • Add Readme to project
  • Create basics structures
  • Create base Models
  • Create base UseCases
  • Add a Database
  • Add a ORM System
  • Refactor using a dependency injection system
  • Create a usage documentation to project
  • Create all the user system
    • Create models and UseCase

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Denis Alves - @3denis - [email protected]

Project Link: https://github.com/denis2710/rentex

(back to top)

About

A platform to you rent a car. Did using Typescript and NodeJs, just to pratice.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published