Padrão README + Docker

Nome do Projeto

ReadMe Oficial do Módulo Nome da Equipe desenvolvedora ©, parte fundamental do Projeto Nome do Projeto - Descrição do projeto....

• Nome do Projeto © Copyright. Todos os direitos reservados.
  Nome do Projeto

• Link: link.com.br
  link.com.br

Inicializando o sistema

• O Nome do Projeto se trata de um sistema de SaaS-Web sob arquitetura MVC (um sólido design pattern, otimizado para Web Apps).
• Estas instruções irão lhe dar uma cópia do projeto em execução na sua máquina local para fins de teste e desenvolvimento.

Pré-Requisitos

• As linhas de comandos (CLI) fundamentais para startar(Run) o projeto estão documentadas no arquivo RDOCME.md.

Dependências:

- ...
- ...
- ...
- ...
- ...

O software foi desenvolvido pelo Nome da Equipe Endereço da Equipe com tecnologias de ponta bla..bla...bla

[Git Flow] Comece por aqui ;)

• Crie uma nova feature: git flow feature start nome-da-feature
• Faça o Commit das suas alterações: git commit -am 'Feat/Add some text
• Ao finalizar a feature: git flow feature finish nome-da-feature
• Publicar uma feature: git flow feature publish nome-da-feature
• Empurre suas alterações para o Github: git push origin develop
• Crie um novo Release: ...

Como escrever as mensagens de commit

Para manter nossos Commits organizados, vamos adotar as seguintes nomeclaturas em mensagens de commits.

• chore: add Oyster build script
• docs: explain hat wobble
• feat: add beta sequence
• fix: remove broken confirmation message
• refactor: share logic between 4d3d3d3 and flarhgunnstow
• style: convert tabs to spaces
• test: ensure Tayne retains clothing

Rodando ambiente com Docker

Acesse o diretório em que o repositório foi clonado através do terminal e execute os comandos:

• docker-compose build para compilar imagens, criar containers etc.
• docker-compose up para instalar as gemas, criar banco de dados e inicializar o servidor

Populando o banco de dados para os dados iniciais

docker-compose run --rm app bundle exec rails db:seed

Iniciando e finalizando containers

Para inicializar execute o comando docker-compose start e para finalizar docker-compose stop

Acessando o container rails

Execute o comando docker-compose run --rm app

Acessando o console

Execute o comando docker-compose run --rm app bundle exec rails c

Acessando o terminal do container

Execute o comando docker-compose exec app bash

Visualizando o log do servidor

Execute o comando docker-compose logs -f --tail=100 rails

Se quiser rodar outros comandos

Será necessário executar o comando completo bundle exec ...

para utilizar o login social (facebook)

Será necessário editar o arquivo .env.example para .env e inserir as credênciais