An open API service indexing awesome lists of open source software.

https://github.com/claudio-code/clean-architecture-api

:memo:
https://github.com/claudio-code/clean-architecture-api

Last synced: 3 months ago
JSON representation

:memo:

Awesome Lists containing this project

README

        


:whale2: Projeto para estudo

## O que é nessesario para rodar a aplicação ?

Para rodar o projeto você precisará do [docker](https://www.docker.com) e [docker-compose](https://docs.docker.com/compose/) instalados no seu computador, o python no path do sistema e tambem é preciso estar tem um sistema que tenha suporte a Makefile e a scripts de bash.

- url base da api = [localhost](http://localhost:8000/);
- url da documentação do swagger = [swagger](http://localhost:8000/doc);
- url da documentação do postman = [postman](https://documenter.getpostman.com/view/7588133/Uyr7Hyng);


Usuario já cadastrado no sistema

Como o sistema necessita de um login para poder ser acessado ele já vem com um usuario adm cadastrado, segue os dados do usuario para login:

#### Username: [email protected]
#### Password: 123

## Como usar ?

- Fazer o setup do projeto : Esse comando alem do setup vai rodar as migrations, os testes e abrir uma aba no seu navegador com o swagger do projeto :blush:.
```
make startup
```

## Caso o comando a cima não rode as migrations e os testes pode rodar os comandos a baixo sem problemas.

- Para rodar as migrations
```
make migrate
```

- Para rodar os testes
```
make test
```