Moz location

🌱 Sua api para consultar a lista das provincias e distritos de Mocambique.

Tabela de conteúdos

• Sobre o projeto

• Funcionalidades

• Como executar o projeto

  • Pré-requisitos
  • Rodando a API

• Tecnologias

• Como contribuir no projeto

• Autor

• Licença

💻 Sobre o projeto

Moz location - é uma api que retorna informacoes das divisoes geograficas de Mocambique,desde provincias ate postos admnistrativos.

---

⚙️ Funcionalidades

• Listagem de provincias do Pais
• Detalhes de uma provincia especifica
• Listagem de distritos por provincias
• Listagem de postos administrativos por provincias

---

🚀 Como executar o projeto

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js. Além disto é bom ter um editor para trabalhar com o código como VSCode

🎲 Rodando a api

# Clone este repositório
$ git clone git@github.com:GabrielTimba/moz-location.git

# Instale as dependências
$ npm install ou yarn

#Execute as migration
$ node ace migration:run  

#Execute seeds
$ node ace db:seed

# Execute a aplicação em modo de desenvolvimento
$ npm run dev ou yarn dev

# O servidor inciará na porta:3333 - acesse http://localhost:3333 

---

🛠 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

API (NodeJS + TypeScript)

• Adonisjs
• postgresql

Veja o arquivo package.json

Utilitários

• Editor: Visual Studio Code
• Markdown: Markdown Emoji
• Teste de API: Insomnia

---

👨‍💻 Contribuicoes

💪 Como contribuir no projeto

1. Faça um fork do projeto.
2. Crie uma nova branch com as suas alterações: git checkout -b my-feature
3. Salve as alterações e crie uma mensagem de commit contando o que você fez: git commit -m "feature: My new feature"
4. Envie as suas alterações: git push origin my-feature

---

🦸 Autor

_{Gabriel Timba}

---

📝 Licença

Este projeto esta sobe a licença MIT.

Feito com ❤️ por Gabriel Timba 👋🏽 Entre em contato!