Skip to content

Latest commit

 

History

History
59 lines (35 loc) · 2.33 KB

README.md

File metadata and controls

59 lines (35 loc) · 2.33 KB


Título

Projeto que disponibiliza em formato de api o cardapio dos restaurantes universitarios UFFS. Esse projeto já está em produção e você pode ver os endpoints em: https://zzumgq.deta.dev/docs ou https://api-ru-uffs.herokuapp.com/docs

✨ Features

  • ✔️ Fácil integração;
  • 🥢 Poucas dependências;

🚀 Começando

1. Primeiro passo para começar

Instale as dependencias do projeto com:

pip install -r requirements.txt

Execute o uvicorn para ter o projeto em seu navegador

uvicorn main:app --reload

acesse em: http://127.0.0.1:8000/docs

2. Outro(s) passo(s)

🤝 Contribua

Sua ajuda é muito bem-vinda, independente da forma! Confira o arquivo CONTRIBUTING.md para conhecer todas as formas de contribuir com o projeto. Por exemplo, sugerir uma nova funcionalidade, reportar um problema/bug, enviar um pull request, ou simplemente utilizar o projeto e comentar sua experiência.

Veja o arquivo ROADMAP.md para ter uma ideia de como o projeto deve evoluir.

🎫 Licença

Esse projeto é licenciado nos termos da licença open-source MIT e está disponível de graça.

🧬 Changelog

Veja todas as alterações desse projeto no arquivo CHANGELOG.md.

🧪 Projetos semelhates

Esse projeto está sendo atualmente utilizado em: