https://github.com/samuel-ricardo/routes_manager-api
NestJS API to manage Routes and Navigations
https://github.com/samuel-ricardo/routes_manager-api
Last synced: 3 months ago
JSON representation
NestJS API to manage Routes and Navigations
- Host: GitHub
- URL: https://github.com/samuel-ricardo/routes_manager-api
- Owner: Samuel-Ricardo
- License: mit
- Created: 2023-07-10T13:37:34.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-23T20:58:29.000Z (almost 2 years ago)
- Last Synced: 2025-01-14T12:43:44.765Z (5 months ago)
- Language: TypeScript
- Size: 141 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Routes_Manager-API
🚀 🟥 Discovery 🟥 🚀
Application developed with the purpose of studying the NestJS Ecosystem
#
|
Overview |
Technologies |
Project |
Routes |
Run |
Author |
#
| :artificial_satellite: About:
This API target is to explore a Clean Architeture implementation With NestJS Framework, fro this, i coded an traditional CRUD that manages Routes and apply some business rules using TypeORM and SQLite Database with a complete development ambient using Docker.
:building_construction: | Technologies and Concepts Studied:
> 
- NestJS - [Express]
- TypeORM
- SQLite
- Swagger | [Documentation]
- JS | Typescript
- Test | Jest
- Docker
- eslint
- prettier
- husky
- lint-sataged
- @swc | [Rust Compiler]
> Among Others...
#
💻 | Application:
In @Core folder you can find the heart of the software where all business rules are applied, the idea is that you can pick this folder and put in any project that it still working without adaptations, the NestJS is just a implementation and is Nest that need to adapt to my @Core
About the routes you can create and list Routes and store in SQLite Database (loca-storage)
Application use the powerfull swc a fast rust compiler and a complete dev ambient, code formater and verify code errors, automated tests and Docker contaieners
> API Example:
```bash
$ route_manager > api.http
GET http://localhost:3000/prefixo/hello
###
GET http://localhost:3000/routes
###
POST http://localhost:3000/routes
Content-Type: application/json
{
"title": "minha rota",
"startPosition": { "lat": 0, "lng": 1 },
"endPosition": { "lat": 2, "lng": 3 }
}
```
#
👨💻 | How to use
### Open your Git Terminal and clone this repository
```git
$ git clone "[email protected]:Samuel-Ricardo/Routes_Manager-API.git"
```
### Make Pull
```git
$ git pull "[email protected]:Samuel-Ricardo/Routes_Manager-API.git"
```
This application use `Docker` so you dont need to install and cofigurate anything other than docker on your machine.
> 
Navigate to project folder `$ cd ./route_manager/` and run it using `docker-compose`
```bash
# After setup docker environment just run this commmand on root project folder:
$ docker-compose up --build # For First Time run this command
$ docker-compose up # to run project
```
You can also run NestJS Directly without Docker [[HERE](https://github.com/Samuel-Ricardo/Routes_Manager-API/blob/main/route_manager/README.md)]
```bash
#Apps Running on:
$ API: http://localhost:3000
See more: ./route_manager/docker-compose.yaml
```
#
:octocat: | Author:
