https://github.com/jtemporal/porondeandei
https://github.com/jtemporal/porondeandei
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/jtemporal/porondeandei
- Owner: jtemporal
- Created: 2021-10-11T18:23:47.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-10-11T19:10:37.000Z (over 4 years ago)
- Last Synced: 2025-01-12T18:35:27.967Z (over 1 year ago)
- Size: 6.84 KB
- Stars: 10
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Por Onde Andei: Edição Palestras
Esta API é escrita em Flask e usa Pandas, Folium e Auth0. Seu objetivo principal é servir um mapa de lugares que foram marcados.
## Requirements
- Python == `3.8.2`
- Flask == `2.0.0`
- Uma conta gratuita da Auth0, [cadastre-se gratuitamente aqui](https://a0.to/jtemporal-signup-for-auth0).
## Environment
```console
pip install -U pip
pip install -r requirements.txt
```
## Configurações
Crie o arquivo `.config` seguindo o arquivo de exemplo `.example.config` e preencha os valores faltantes.
## Rodando a API
### Em desenvolvimento
```console
flask run
```
Acesse: [http://127.0.0.1:5000/](http://127.0.0.1:5000/).
### Em produção
```
gunicorn app:app
```
Acesse: [http://127.0.0.1:8000/](http://127.0.0.1:8000/).
## Como Usar Esse Repo
### Navegando pelos branches
| Branch | Explicação |
| ----------- | ------- |
| `main` | Tudo que você precisa para fazer o setup inicial do projeto |
| `passo-1` | Vamos criar os dois primeiros endpoints, templates e rodar o projeto |
| `passo-2` | Vamos criar os dois endpoints que geram o nosso mapa e as funções que fazem ajustes de dados |
| `passo-3` | Vamos configurar a conta na Auth0 e proteger os endpoints |
| `passo-4` | Momento do deploy, configurar o código para o Heroku |