https://github.com/yagoluiz/delivery-api
Beverage delivery API using MongoDB and NodeJS
https://github.com/yagoluiz/delivery-api
docker docker-compose geolocation mongodb nodejs
Last synced: 7 months ago
JSON representation
Beverage delivery API using MongoDB and NodeJS
- Host: GitHub
- URL: https://github.com/yagoluiz/delivery-api
- Owner: yagoluiz
- Created: 2020-01-07T17:42:53.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-09-12T06:16:07.000Z (about 5 years ago)
- Last Synced: 2025-01-23T16:53:25.440Z (9 months ago)
- Topics: docker, docker-compose, geolocation, mongodb, nodejs
- Language: JavaScript
- Homepage:
- Size: 474 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Delivery API
Beverage delivery API, responsible for reporting or nearest point of delivery via geolocation.
## Data information
Data is stored in **MongoDB** database using geolocation.
If desired, the collection for initial data is present in the **database folder**, **partners.json** file.
In the same folder, the **geojson.json** file presents the geolocation of collection partners for viewing on [geojson.io](http://geojson.io/) site.
## Instructions for run project
### npm
For run project and integration testing the database must be run.
- Run application:
`npm start`
or
`npm run dev` (nodemon)
- Test application:
`npm test`
### Container
- Docker Compose:
`docker-compose up -d`
### Endpoints
The **endpoints.http** file has the API endpoints.
In VS Code, install [REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) extension to run the tests.
Otherwise, execute the endpoints on the desired tool.