kaikelfalcao / agenda-Flask-Angular

agenda-Flask-Angular 💻

Tecnologias • Se preparando • APP Routes • Colaboladores • Contribua

Por enquanto, apenas uma API para CRUD de contatos de uma agenda com autenticação

💻 Tecnologias

• Flask

🚀 Se preparando

Para rodar a API siga os seguintes passos

Prerequisites

• PYTHON
• FLASK

Cloning

Para clonar basta rodar

git clone https://github.com/LimeHawk/agenda-Flask-Angular.git

Starting

Para começar siga esses Passos:

cd agenda-Flask-Angular
cd BackEnd

Crie um .env com as seguintes informações e salve na raiz do projeto:

DATABASE_NAME = "./app/database/agenda.db"
LOGINACESS = "seu_login"
PASSWORD ="sua_senha"
JWT_ENCRYPTION_KEY = "sua_chave"

Windows

pip install -r requirements.txt
cd  app/database
python create_database.py
cd .. 
cd .. 
python main.py

Ubuntu

cd agenda-Flask-Angular
cd BackEnd
pip install -r requirements.txt
cd  app/database
python3 create_database.py
cd .. 
cd .. 
python3 main.py

📍 Application Routes

Para ter acesso a outras funções primeiro você precisa ter o token.

Como você estará rodando localmente todas as saidas estarão na http://127.0.0.1:5000 ​

route	request	response
POST /api/v1/login	json with email and senha	json access_token
Get /api/v1/contato	None	Lista de contatos no BD
POST /api/v1/contato	json with nome and email and telefone	json message
PUT /api/v1/contato	json with nome and email and telefone and id	json message
DELETE /api/v1/contato/string:id	None	json message

🤝 Collaborators

Special thank you for all people that contributed for this project.

Kaíke Falcão

📫 Contribute

Apenas seguir os passos abaixo para contribuir, será de enorme ajuda

1. git clone https://github.com/LimeHawk/agenda-Flask-Angular.git
2. git checkout -b feature/NAME
3. Follow commit patterns
4. Open a Pull Request explaining the problem solved or feature made, if exists, append screenshot of visual modifications and wait for the review!

Documentations that might help

📝 How to create a Pull Request

💾 Commit pattern