API WEDEV - PLATAFORMA DE CURSOS

Desafio Wedev.software

Tecnologias

- FastAPI
- SqlAlchemy
- PostgreSQL
- Black/PEP8 (lint)
- Tailwind
- Pytest

Módulos (CRUD)

- Usuários (based role) -> professor, aluno e staff
- Cursos

Configurações do projeto:

Para configurar o container refaça os seguintes passos antes de prosseguir (garanta que o docker esteja instalado e configurado corretamente em sua máquina)

Iniciando

Abra o terminal na raiz do projeto e execute o seguinte comando:

    docker-compose up

Após isso container será executado em sua máquina

Para acessar abra o seu navegador e digite a seguinte url: http://localhost:8000

O container será executado com FastAPI e PostgreSQL, porém sem as migrações do banco de dados!

Para continuar o processo de instalação deixe o postgres rodando em um outro terminal e execute o bashscript presente na raiz do projeto:

    $ chmod +x ./pre_start.sh
    $ ./pre_start.sh

Aguarde as migrações e os seeds executarem e por fim inicie o projeto novamente (não esqueça de matar o processo do docker compose aberto no outro terminal:

    # para ligar
    docker-compose start
    # para desligar
    docker-compose stop

Documentação

`Swagger OpenAPI`
- http://localhost:8000/docs

Rodando testes

Abra o terminal e digite o seguinte comando:

    pytest