Paulo-Lopes-Estevao / backend-risk-place

Web API - service responsible for providing data.

backend Risk Place

Começar

Pré-requisitos

• Golang - The language used
• Docker - Containerization platform
• Docker Compose - Container orchestration

Instalando

• Instalar o Golang e configurar o ambiente de desenvolvimento.

• Versão do Golang utilizada: 1.19.2

• Clonar o repositório

git clone https://github.com/risk-place-angola/backend-risk-place.git

• Criar uma cópia do ficheiro .env.example' e renomeá-lo para .env'.

cp .env.example .env

• Instalar as dependências

go mod tidy

• Execute o seguinte comando para iniciar a aplicação

go run main.go

Realização dos testes

• Executar o seguinte comando para executar os testes

go test ./...

Construído com

• Golang - The language used
• Echo - Web framework
• GORM - ORM
• air - Live reload

🤝 Contribuição

Antes de abrir uma issue ou pull request, verifique o documentos de contribuição do projeto.

Por favor leia CONTRIBUTING.md para detalhes sobre o nosso código de conduta, e o processo para submeter pedidos de pull.

Diagrama de entidade

Detalhes para cada entidade do diagrama

• Place Type: Tipo de locais que podem ser cadastrados no sistema. Ex: Riscos, Trabalho, Escola, Parque, Igreja, Hospital etc.

Nota: O tipo de local é um campo obrigatório para o cadastro de um local. O primeiro local que vamos utilizar é o tipo Risco.

• Riscos: Vão cadastrar os locais que consideram riscos. Ex: Bairro X, Rua Y, Latitude, Longitude etc.

• Tipos de um riscos: aqui vamos cadastrar os tipos riscos que podem ser encontrados em um local. Ex: Criminalidade, Vala, doença.

  • Topicos: aqui vamos cadastrar os tópicos de um risco. Ex: Assalto, Incêndio, Furto, Assalto, Acidente, Roubo, Inundação etc.

🍕 Comunidade

Junte-se à conversa ao nosso https://discord.gg/s2Nk4xYV