https://github.com/mk-nascimento/fastapi-taskmaster-coverage

Esta é uma aplicação RESTful API construída com FastAPI, SQLAlchemy, MariaDB e Poetry como gerenciador de dependências.
https://github.com/mk-nascimento/fastapi-taskmaster-coverage

factory-boy fastapi fastapi-sqlalchemy mariadb pydantic pydantic-settings pytest python-3

Last synced: about 1 month ago
JSON representation

Esta é uma aplicação RESTful API construída com FastAPI, SQLAlchemy, MariaDB e Poetry como gerenciador de dependências.

• Host: GitHub
• URL: https://github.com/mk-nascimento/fastapi-taskmaster-coverage
• Owner: mk-nascimento
• License: apache-2.0
• Created: 2024-06-14T19:25:40.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-09-02T03:42:17.000Z (5 months ago)
• Last Synced: 2024-11-08T04:44:29.529Z (3 months ago)
• Topics: factory-boy, fastapi, fastapi-sqlalchemy, mariadb, pydantic, pydantic-settings, pytest, python-3
• Language: Python
• Homepage: https://fastapi-taskmaster-coverage.onrender.com
• Size: 24.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# FastAPI Taskmaster Coverage

Esta é uma aplicação RESTful API construída com FastAPI, SQLAlchemy, MariaDB e gerenciada pelo Poetry.

## Pré-requisitos

Certifique-se de ter os seguintes itens instalados em sua máquina:

- [![MariaDB 11+](https://img.shields.io/badge/MariaDB-11+-brown.svg?logo=mariadb)](https://mariadb.org/download/?t=mariadb&p=mariadb&r=11.0.0)

- [![Python 3.11+](https://img.shields.io/badge/Python-3.11+-blue.svg?logo=python)](https://www.python.org/downloads/release/python-3110/)

- [![Poetry 1.8+](https://img.shields.io/badge/Poetry-1.8+-blue.svg?logo=poetry)](https://python-poetry.org/docs/#installation)

## Configuração do Ambiente

1. Clone o repositório:

    ```sh

    git clone https://github.com/mk-nascimento/fastapi-taskmaster-coverage.git

    cd fastapi-taskmaster-api

    ```

2. Instale as dependências:

    - Poetry

        > Antes de prosseguir com a instalação, é recomendado verificar a versão do Python e Poetry recomendada no topo deste arquivo. Certifique-se de ter a versão correta instalada em seu sistema antes de continuar.

        ```sh

        poetry install

        ```

    - Ou, se você preferir usar pip:

        > Antes de prosseguir com a instalação, é recomendado verificar a versão do Python recomendada no topo deste arquivo. Certifique-se de ter a versão correta instalada em seu sistema antes de continuar.

        ```sh

        pip install -r requirements.txt

        ```

3. Crie e configure o banco de dados PostgreSQL. Em seguida, crie um arquivo `.env` na raiz do projeto baseado no arquivo [.env.example](.env.example):

    - Copie o conteúdo de [.env.example](.env.example) para um novo arquivo `.env` e atualize as credenciais conforme necessário:

        ```sh

        cp .env.example .env

        ```

4. Ative o ambiente virtual:

    - Poetry:

        ```sh

        poetry shell

        ```

    - Ou, caso utilize um ambiente virtual criado com `venv`:

        ```sh

        # Crie um ambiente virtual com o nome desejado, substituindo "" por um nome escolhido:

        python -m venv 

        ```

        - Sistemas Unix-like "Linux/Mac":

            ```sh

            source /bin/activate  # Linux/Mac

            ```

        - Sistemas Windows:

            ```PowerShell

            \Scripts\activate     # Windows

            ```

5. Execute as migrações do banco de dados:

    ```sh

    alembic upgrade head

    ```

## Rodando a Aplicação

Execute a aplicação com o comando:

```sh

uvicorn taskmaster.main:app --reload

```

A API estará disponível em http://127.0.0.1:8000.

## Licença

Este projeto está licenciado sob a licença Apache 2.0 - veja o arquivo [LICENSE](LICENSE) para detalhes.