https://github.com/marcusvbrangel/rentalx
https://github.com/marcusvbrangel/rentalx
eslint express javascript node npm prettier ts-node-dev typescript uuid
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/marcusvbrangel/rentalx
- Owner: marcusvbrangel
- License: mit
- Created: 2022-02-28T12:41:12.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2023-03-07T12:21:40.000Z (over 3 years ago)
- Last Synced: 2025-01-29T07:40:05.768Z (over 1 year ago)
- Topics: eslint, express, javascript, node, npm, prettier, ts-node-dev, typescript, uuid
- Language: TypeScript
- Homepage:
- Size: 487 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](code_of_conduct.md)
# RentalX
## About :cyclone:
#### xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.
## Tests :cyclone:
- [ x ] Should be able to create a new repository.
- [ x ] Should be able to list the projects.
- [ x ] Should be able to update repository.
- [ x ] Should not be able to update a non existing repository.
- [ x ] Should not be able to update repository likes manually.
- [ x ] Should be able to delete the repository.
- [ x ] Should not be able to delete a non existing repository.
- [ x ] Should be able to give a like to the repository.
- [ x ] Should not be able to give a like to a non existing repository.
## Application routes :cyclone:
* GET /repositories
* POST /repositories
* PUT /repositories/:id
* DELETE /repositories/:id
* POST /repositories/:id/like
## Prerequisites :cyclone:
Make sure you have installed all of the following prerequisites on your development machine:
* Git - [Download & Install Git](https://git-scm.com/downloads/). OSX and Linux machines typically have this already installed.
* Node.js - [Download & Install Node.js](https://nodejs.org/en/download/) and the npm package manager.
## Dependency libraries :cyclone:
* express
* uuid
* jest
* nodemon
* supertest
## Getting Started :cyclone:
1. Clone this repository
```sh
git clone https://github.com/marcusvbrangel/rentalx.git
```
2. Install the dependencies
```sh
npm install
```
3. Start the app
```sh
npm run dev
```
## Contributing :cyclone:
Have a look through existing [Issues](https://github.com/marcusvbrangel/rentalx/issues) and [Pull Requests](https://github.com/marcusvbrangel/rentalx/pulls) that you could help with.
If this is your first time contributing to this project, please do read our [Contributor Workflow Guide](https://github.com/the-guild-org/Stack/blob/master/CONTRIBUTING.md) before you get started off.
Feel free to open issues and pull requests. We're always welcome support from the community.
## Code of Conduct :cyclone:
Help me keep this project open and inclusive. Please read and follow our [
of Conduct](https://github.com/the-guild-org/Stack/blob/master/CODE_OF_CONDUCT.md) as adopted from [Contributor Covenant](https://www.contributor-covenant.org/)
## Acknowledgments :cyclone:
[Rocketseat](https://www.rocketseat.com.br/)
## Contact :cyclone:
* Email: marcus.vbrangel@gmail.com
* GitHub: https://github.com/marcusvbrangel/
* Twitter: https://twitter.com/marcusvbrangel/
* LinkedIn: https://www.linkedin.com/in/marcusrangel/
## License :cyclone:
Copyright (c) Marcus Rangel. All rights reserved.
Licensed under the [MIT](LICENSE.md) license.