https://github.com/augusto240/pripis2024_ok

https://github.com/augusto240/pripis2024_ok

Last synced: 11 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/augusto240/pripis2024_ok
• Owner: Augusto240
• License: mit
• Created: 2024-09-24T17:08:02.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-10-24T14:01:46.000Z (3 months ago)
• Last Synced: 2024-10-24T16:20:40.326Z (3 months ago)
• Language: CSS
• Size: 2.31 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Sistema de cadastro de carros e motoristas

## Sobre

A aplicação é essencialmente um sistema de cadastro de carros associados a seus motorista com suporte a leitura e validação de QRcode e recebimento de mensagens via MQTT.

Feito utilizando Angular com Node.js(express) e implantado através de contêineres Docker.

## Guia para instalação e execução do sistema.

O programa foi planejado para ser executado em contêineres através do uso do Docker se utilizando do Docker compose. A maneira mais fácil é instalando o [Docker Desktop](https://www.docker.com/products/docker-desktop/) que na instalação já inclui ambos serviços.

Caso queira instalar os serviços individualmente, veja [aqui](https://docs.docker.com/engine/install/) como instalar o Docker no seu sistema operacional e [aqui](https://docs.docker.com/compose/install/) como instalar o Docker Compose.

### Comandos para rodar a aplicação com contêineres:

Para construir e subir os contêineres que rodam toda a aplicação:

~~~bash

docker compose up --build -d

~~~

No caso de querer apagar os contêineres:

~~~bash

docker compose down

~~~

Se for também necessário apagar o banco de dados e os outros volumes:

~~~bash

docker compose down --volumes

~~~

#### As seguintes portas serão ocupadas uma vez que o sistema estiver rodando:

* 80 e 443: Angular (frontend)

* 3000: Express com Node.js (backend)

* 3306: MySQL

* 8081: PHPMyAdmin

* 1884: MQTT broker

#### A configuração padrão do server nginx conta com dois endereços

* https://seu_endereço/ : Interface web de cadastro

* https://seu_endereço/api : Solicitações para a api

Substitua "seu_endereço" pelo IP da sua máquina ou nome do host.

### Swagger

Para acessar a documentação com os endpoints e suas funções entre em https://seu_endereço/api/docs/