https://github.com/devseeder/places
API Service with NestJS, Puppeteer, MongoDB, RabbitMQ to get places by local names
https://github.com/devseeder/places
api cities countries mongodb neighborhoods nestjs nodejs places puppeteer states typescript
Last synced: 6 months ago
JSON representation
API Service with NestJS, Puppeteer, MongoDB, RabbitMQ to get places by local names
- Host: GitHub
- URL: https://github.com/devseeder/places
- Owner: DevSeeder
- Created: 2022-05-17T00:59:08.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-09-08T16:44:51.000Z (about 3 years ago)
- Last Synced: 2023-10-08T01:27:40.152Z (almost 2 years ago)
- Topics: api, cities, countries, mongodb, neighborhoods, nestjs, nodejs, places, puppeteer, states, typescript
- Language: HTML
- Homepage:
- Size: 1.71 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.MD
Awesome Lists containing this project
README
[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
[circleci-url]: https://circleci.com/gh/nestjs/nest
[url-prod]: http://places.devseeder.com/api
This project use NestJS, a progressive Node.js framework for building efficient and scalable server-side applications.
## Technologies
- NestJS
- NodeJS
- Puppeteer
- MongoDB
- RabbitMQ
- JWT Auth
## Description
API to get Places by Local Names.
- Neighborhoods
- Cities
- States
- Regions
- Countries
## Installation
```bash
$ npm install
```
## Running the app
```bash
# development
$ npm run start
# watch mode
$ npm run start:dev
# production mode
$ npm run start:prod
```
## Test
```bash
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
```
## Contact
maicksantos05@hotmail.com
## Example
After run the server, make a get in browser, postman or similar
```bash
## Neighborhoods By City example
http://places.devseeder.com/api/neighborhoods/city/brazil/sc/orleans
## Neighborhoods By State example
http://places.devseeder.com/api/neighborhoods/state/brazil/sc
## Cities By State example
http://places.devseeder.com/api/cities/state/brazil/sc
## Cities By Country example
http://places.devseeder.com/api/cities/country/brazil
## States By Country example
http://places.devseeder.com/api/states/country/brazil
## Countries example
http://places.devseeder.com/api/countries/
```
[Swagger](https://app.swaggerhub.com/apis/dev-seeder/Places/)
At the moment, it's working only for Brazilians Neighborhoods.