https://github.com/mahtf/rentalx
Código desenvolvido em Typescript utilizando NodeJS para aprendizagem.
https://github.com/mahtf/rentalx
Last synced: 8 months ago
JSON representation
Código desenvolvido em Typescript utilizando NodeJS para aprendizagem.
- Host: GitHub
- URL: https://github.com/mahtf/rentalx
- Owner: MahTF
- License: mit
- Created: 2021-10-18T13:01:38.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-06T13:28:26.000Z (over 3 years ago)
- Last Synced: 2023-03-07T01:39:01.344Z (over 3 years ago)
- Language: TypeScript
- Size: 871 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
RentalX
Descrição |
Iniciando |
O que contém? |
Licença
> under construction...
## :clipboard: Descrição
Este projeto é sobre uma locadora de veículos, realizado em NodeJs e Docker.
## :rocket: Iniciando
1. Clone o repositório
- Usando Git
```shell
git clone https://github.com/mahtf/rentalx.git
```
- Usando Github CLI
```shell
gh repo clone mahtf/rentalx
```
> :bulb: ou como preferir
2. Installation
- Rode o comando
```shell
yarn
```
3. Execução
- Utilizando docker, rode o comando
```shell
docker-compose up
```
- Rode as migrações em outro terminal usando o comando
```shell
yarn typeorm migration:run
```
## 🧐 O que contém?
### :building_construction: Tecnologias
- [NodeJs](https://nodejs.org/)
- [Typescript](https://www.typescriptlang.org)
### :lipstick: Linter tools
- [ESLint](https://eslint.org)
- [Prettier](https://prettier.io)
### :package: Packages
- [Express](https://expressjs.com)
- [Ts-Node-Dev](https://www.npmjs.com/package/ts-node-dev)
- [UUID](https://www.npmjs.com/package/uuid)
- [CSV-Parse](https://csv.js.org/parse/)
- [Multer](https://www.npmjs.com/package/multer)
- [Postgres](https://www.npmjs.com/package/pg)
- [Swagger](https://swagger.io)
- [TSyringe](https://www.npmjs.com/package/tsyringe)
- [TypeOrm](https://typeorm.io/#/)
- [bcryptjs](https://www.npmjs.com/package/bcryptjs)
- [jsonwebtoken](https://www.npmjs.com/package/jsonwebtoken)
- [jest](https://jestjs.io/)
### A quick look at the top-level directories inside the `./src`.
./src
├── database
├── modules
├── routes
├── shared
1. **`database`**: arquivos de migrações do banco de dados da aplicação.
2. **`modules`**: todos os modulos da aplicação, como entidades e useCases.
3. **`routes`**: rotas da aplicação.
4. **`shared`**: arquivos que são compartilhados pela aplicação.
## :memo: Licença
Este projeto está sob a licença MIT. Veja o arquivo [LICENSE](LICENSE) para mais detalhes.
---
Build with 💙 By [Marcelo Ferreira](http://github.com/mahtf)
Based on the [readme template](https://gist.github.com/henry-ns/a00234378353d9ca43e1bfe043202192) by [Henrique Miranda](http://thehenry.dev/)