O SoLanches é um sistema web, criado e desenvolvido durante a disciplina de Engenharia de Software do curso de Ciência da Computação na Universidade Federal de Campina Grande, que tem como objetivo exibir todos os comércios do ramo alimentício de cidades pequenas. Neste repositório está presente a API criada para o sistema. O Frontend do sistema e mais detalhes sobre sua documentação podem ser acessados aqui.
A documentação com instruções de uso para requisições à API pode ser encontrada aqui.
- Python - Linguagem de programação
- Flask - Framework
- MongoDB - DataBase
- PyMongo - Distribuição Python para trabalhar com o MongoDB
Crie um arquivo chamado .env para as variáveis de ambiente e coloque as variáveis necessárias para a execução do projeto. Exemplo em: Variáveis de Ambiente
Para executar o sistema de forma automática, basta utilizar o seguinte comando
$ make run
Se optar por executar a API de forma manual, siga os seguintes passos
- Crie o ambiente virtual
$ python3 -m venv venv
- Ative o ambiente virtual
$ source venv/bin/activate
- Instale as dependências
$ pip install -r requirements.txt
- Rode a aplicação
$ python3 -m solanches
Para executar os testes, basta rodar o comando
$ make test
Se optar por executar manualmente, instale as dependências presentes no arquivo tests-requirements.txt e digite o seguinte comando:
$ python3 -m pytest
Para analisar a cobertura dos testes, utilize o comando make test-cov.