wrath-codes/puc-rio-sprint-01-backend

Como instalar a Recipes API

Pré-requisitos

• Python 3.11.2
• Pip3
• venv

Como instalar

1. Clone o repositório

2. Crie um ambiente virtual

   python3 -m venv venv

3. Ative o ambiente virtual

   • Windows

     source venv\Scripts\activate

   • Linux

     source venv/bin/activate

   • MacOS

     source venv/bin/activate

4. Instale as dependências

   pip3 install -r requirements.txt

5. Rode o main.py

   python3 main.py

   • O main.py cria o banco de dados e inicia a API.

6. Acesse a API em http://localhost:8000/

7. Caso queira popular o banco de dados com dados de teste, rode o arquivo seeder.py

   python3 seeder.py

   • O arquivo seeder.py cria algumas receitas, ingredientes e passos no banco de dados.

Descrição do projeto

• A Recipes API é uma API que permite o cadastro de receitas, ingredientes e passos, além de permitir a busca de receitas por título.
• O projeto foi desenvolvido utilizando o framework FastAPI. Ele permite a criação de documentação automática e interativa, além de ser fácil de usar e rápido.
• O banco de dados utilizado foi o SQLite, que é um banco de dados leve e rápido, ideal para projetos pequenos.
• O ORM utilizado foi o SQLAlchemy, que permite a criação de classes que representam tabelas do banco de dados, além de facilitar a criação de queries.