Merge pull request #14 from maick05/feature/first-version

Feature/first version

.github/workflows/e2e-tests.yml

@@ -0,0 +1,21 @@
+name: e2e
+on:
+  push:
+    branches:
+      - main
+      - development
+jobs:
+  e2eTests:
+    name: e2e-Tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
+      - name: install
+        run: npm install
+      - name: e2e test
+        run: npm run test:e2e
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed to get PR information, if any
+

.github/workflows/main.yml → .github/workflows/sonar-unit-tests.yml

@@ -1,4 +1,4 @@
-name: Build Sonar
+name: Build Sonar Unit Tests
 on:
   push:
     branches:

.gitignore

@@ -34,6 +34,7 @@ lerna-debug.log*
 !.vscode/launch.json
 !.vscode/extensions.json
 node_modules
+*.code-workspace
 
 # Sonar
 .scannerwork/.sonar_lock

.scannerwork/report-task.txt

@@ -3,5 +3,5 @@ projectKey=maick05_places
 serverUrl=https://sonarcloud.io
 serverVersion=8.0.0.29264
 dashboardUrl=https://sonarcloud.io/dashboard?id=maick05_places
-ceTaskId=AYD9UWJG_z939kpPOwHR
-ceTaskUrl=https://sonarcloud.io/api/ce/task?id=AYD9UWJG_z939kpPOwHR
+ceTaskId=AYEShHKEx7rM3OF9_Y2O
+ceTaskUrl=https://sonarcloud.io/api/ce/task?id=AYEShHKEx7rM3OF9_Y2O

README.md

@@ -5,26 +5,13 @@
 [circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
 [circleci-url]: https://circleci.com/gh/nestjs/nest
 
-  <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
-    <p align="center">
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
-<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
-<a href="https://coveralls.io/github/nestjs/nest?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9" alt="Coverage" /></a>
-<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
-<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
-<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
-  <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg"/></a>
-    <a href="https://opencollective.com/nest#sponsor"  target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
-  <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow"></a>
-</p>
-  <!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
-  [![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
+  <p align="center">This project use <a href="https://github.com/nestjs/nest" target="_blank">NestJS</a>, a progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
 
 ## Description
 
-[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
+API to get Places by Local Names.
+
+- Only Neighborhoods for now
 
 ## Installation
 
@@ -58,7 +45,7 @@ $ npm run test:e2e
 $ npm run test:cov
 ```
 
-## Support
+<!-- ## Support
 
 Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
 
@@ -70,4 +57,21 @@ Nest is an MIT-licensed open source project. It can grow thanks to the sponsors
 
 ## License
 
-Nest is [MIT licensed](LICENSE).
+Nest is [MIT licensed](LICENSE). -->
+
+## Contact
+
+maicksantos05@hotmail.com
+
+## Example
+
+After run the server, make a get in browser, postman or similar
+
+```bash
+## Url example
+http://localhost:3000/neighborhoods/city/brazil/sc/orleans
+```
+
+[Swagger](https://app.swaggerhub.com/apis/dev-seeder/Places/1.0.0)
+
+At the moment, it's working only for Brazil cities.

config/yaml/values.yaml

@@ -2,3 +2,5 @@ repository:
   neighborhoods:
     guia-mais:
       url: 'https://www.guiamais.com.br/bairros'
+api:
+  port: 3000