Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eliasgcf/rentx
Easy way to rent a car
https://github.com/eliasgcf/rentx
api docker docker-compose nodejs typeorm typescript
Last synced: 15 days ago
JSON representation
Easy way to rent a car
- Host: GitHub
- URL: https://github.com/eliasgcf/rentx
- Owner: EliasGcf
- License: mit
- Created: 2021-03-16T01:30:48.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-02-06T20:42:24.000Z (almost 3 years ago)
- Last Synced: 2024-10-04T19:06:18.164Z (about 1 month ago)
- Topics: api, docker, docker-compose, nodejs, typeorm, typescript
- Language: TypeScript
- Homepage:
- Size: 604 KB
- Stars: 6
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Easy way to rent a car
Technologies •
Getting started •
License
## 🚀 Technologies
- [TypeScript](https://www.typescriptlang.org/)
- [Express](https://expressjs.com/)
- [Multer](https://github.com/expressjs/multer)
- [TypeORM](https://typeorm.io/#/)
- [JSON Web Token](https://jwt.io/)
- [PostgreSQL](https://www.postgresql.org/)
- [Jest](https://jestjs.io/)
- [SuperTest](https://github.com/visionmedia/supertest)
## 💻 Getting started
Import the `Insomnia.json` on Insomnia App or click on [Run in Insomnia](#insomniaButton) button.
### Requirements
- [Node.js](https://nodejs.org/en/)
- [Yarn](https://classic.yarnpkg.com/) or [npm](https://www.npmjs.com/)
- [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/)
**Clone the project and access the folder**
```bash
git clone https://github.com/EliasGcf/rentx.git && cd rentx
```
**Follow the steps below**
```bash
# Install the dependencies
$ yarn
# Make a copy of '.env.example' to '.env'
# and set with YOUR environment variables.
# The aws variables do not need to be filled for dev environment
$ cp .env.example .env
# Start all the services and the application with Docker Compose
$ docker-compose up -d
# Once the services are running, run the migrations
$ yarn migration:run
# Run the seeds
$ yarn seed:run
# To finish, run the api service
$ yarn dev:server
# Well done, project is started!
```
## 📝 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
---
Made with 💜 by Elias Gabriel