An api demo for the awesome Zé Delivery engineering team \o/
$ npm installdocker-compose up
You can access the api at the Api Endpoint
If you want to deploy it to an AWS ECS Cluster, please refer to the following docs: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cmd-ecs-cli-compose.html
This project was setup to work with docker, so in order for the tests to work, the docker container with the postgis (https://hub.docker.com/r/kartoza/postgis/) instance must be running, so lets go step by step on how to make the tests run correctly.
1 - Make sure the docker container for both the app and the database is running:
docker-compose up2 - After the containers are up and running, change the ormconfig.json file contents
to this:
{
"type": "postgres",
"host": "0.0.0.0",
"port": 25432,
"username": "root",
"password": "root",
"database": "test",
"entities": ["dist/**/*.entity{.ts,.js}"],
"synchronize": true
}Samples have been provided at the ormconfig.sample.txt file.
3- At this point you can run the tests without any problems
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:covIn order to generate the documentation for this project, please run the following
npm install
npx compodoc -p tsconfig.json -sOnce it is done, visit the url displayed at the bottom line.
The swagger documentation can be viewed at: http://localhost:3000/api
You can use the following website to help in the testing of the features: http://geojson.io/#map=2/20.0/0.0
This project was built with Nest.js
This project uses Nest.js CRUD plugin (https://github.com/nestjsx/crud, https://docs.nestjs.com/recipes/crud-utilities) in order to make pagination and filtering available to all endpoints.
The database used for this project is PostGis
The node version used to develop this application was node.js version v12.10.0
Ubirajara Marsicano Neto
Nest is MIT licensed.