NextLevelWeek 5

Projeto Inmana desenvolvido durante a NLW 5 da Rocketseat

🚀 Setup

Instale a versão mais recente do Elixir, Phoenix e PostgreSQL no seu computador utilizando essas configurações de ambiente.
Para instalar as dependências do projeto e iniciá-lo, execute:

mix deps.get # Instalar deps
mix ecto.create # Criar o database do Inmana
mix ecto.migrate # Executar migrations
mix phx.server # Executar o backend em localhost:4000

Existem também outros comandos CLI para desenvolvimento e testes:

mix format # Corrigir formatação do código
mix compile # Compilar o projeto para ./_build
mix test # Rodar os testes automatizados
mix test --cover # Rodar os testes automatizados + mostrar coverage
mix credo.gen.config # Gerar configurações do linter (credo)
mix credo # Rodar o linter
mix phx.routes # Listar rotas do phoenix
iex -S mix # Testar alguma funcionalidade/modulo separado diretamente pelo iex
mix ecto.gen.migration nome_da_migration # criar arquivo de migration ex.: create_supplies_table 

Assim que terminar, abra em seu navegador a página localhost:4000 para acessar as rotas da aplicação.

📚 Documentação

A documentação do backend foi desenvolvida no Postman e pode ser acessada por aqui.
Caso queira fazer o download da documentação em JSON e importar no Postman, o arquivo da coleção encontra-se em postman_collection.json.

📜 Licença

MIT © Rocketseat