404jv/dev-landia

Criar um .env.example e adicionar explicação na documentação

Closed this issue · 2 comments

404jv commented

Essa deve ser feita quando a #36 estiver fechada. Aqui é só documentação, como .env vai ser ignorado pelo git, podemos criar um arquivo .env.example e deixar apenas os nomes das variáveis para serem preenchida. Depois disso, alterar o passo a passo da instalação para lembrar de clonar o .env.example e preencher as variáveis para a configuração de quem está baixando o projeto.

Detalhes

  • O .env.example pode ter variáveis com valores, desde que não sejam dados pessoais, por exemplo, a variável PORT que é a porta onde o servidor está rodando pode estar preenchida como 3333 no .env.example.
  • Na documentação o passo de clonar o arquivo pode ser feito com o cp assim:
$ cp .env.example .env
  • Exemplo de projeto é o Rentx.

To do

  • Criar o .env.example;
  • Adicionar a variável BASE_URL como vazia no arquivo;
  • Adicionar na documentação ensinando a clonar o arquivo e lembrando o leitor de preencher as variáveis do .env;
404jv commented

Faço essa 🚀

404jv commented

Fechado com o commit 326acad