Skip to content

Latest commit

 

History

History
63 lines (39 loc) · 2.67 KB

README.md

File metadata and controls

63 lines (39 loc) · 2.67 KB

Elixir PlayBook

Logo do projeto

Índice

Sobre o projeto

Este guia tem como objetivo apresentar as melhores práticas e convenções utilizadas no desenvolvimento de projetos em Elixir com a Arquitetura Phoenix. Através deste material, buscamos padronizar e melhorar a qualidade do código, facilitar a compreensão e colaboração entre os desenvolvedores e, consequentemente, aumentar a eficiência no processo de desenvolvimento.

O guia abrange tópicos como Code Style, estrutura de projetos na Arquitetura Phoenix, nomenclaturas, funções no Repo, uso do "alias", integração com APIs externas e considerações finais. Cada seção detalha as práticas recomendadas e exemplos de código para facilitar a compreensão e aplicação desses conceitos no dia a dia.

Ao seguir as orientações propostas neste guia, você estará contribuindo para a criação de um ambiente de desenvolvimento mais organizado e colaborativo, onde todos os membros da equipe poderão trabalhar de maneira eficiente e consistente.

Tecnologia utilizada

Pré-requisitos

Antes de começar faça o fork do repositório para poder contribuir, verifique se você atendeu aos seguintes pré-requisitos:

  • Ter instalado a o LiveBook ou docker e docker compose

Como executar

Depois de configurar o ambiente, siga os passos abaixo para executar o projeto:

Caso tenha optado por instalar o LiveBook em sua máquina siga com essa agordagem, se não pule para a próxima etapa.

livebook server /notebooks/guia_para_os_devs_elixir_phoenix.livemd

Caso tenha optado por utilizar o docker compose siga com estes passos

docker-compose up -d

Depois acesse localhost:8080

autentique com a senha padrão no arquivo docker-compose.yml

Aperte em Open e selecione o nosso arquivo, em seguida aperte open novamente e já terá acesso ao nosso PlayBook e poderá utilizar como referência ou até mesmo contribuir com ideias.