Skip to content

Latest commit

 

History

History
82 lines (52 loc) · 1.55 KB

README.sample.md

File metadata and controls

82 lines (52 loc) · 1.55 KB

Nome do Projeto

Informação adicional

Badges do projeto (CircleCI/CodeClimate/Coverage)

Breve descrição do projeto, objetivos ...

Desenvolvimento

Pré-requisitos

O que é necessário para desenvolver a aplicação, com links de download.

  • Docker
  • Rails
  • Angular
  • Yarn/Npm

Configuração de Ambiente

Explicar como configurar o ambiente antes de rodar a aplicação, com comandos ou informações importantes.

git clone https://github.com/your/your-project.git
cd your-project/
packagemanager install

Descrição dos comandos de shell acima.

Build

Descrição de como criar builds para o projeto ou explicação sobre o processo de build, se é automatizado ...

./configure
make
make install

Descrição dos comandos de shell acima.

Deploy

Explicar como fazer deployment, ou como é feito o deployment automatizado e informações importantes.

packagemanager deploy your-project -s server.com -u username -p password

Descrição dos comandos de shell acima.

Versionamento

Como o versionamento do projeto é feito (Recomendado: SemVer).

Configuration

Como configurar o projeto para execução em produção.

export S3_REGION=us-west-1
export VAR=valor
commando aplicacao ...

Tests

Descrever como executar os testes.

rspec/parallel_rspec

API

Caso a aplicação contenha uma API, link para documentação da mesma.

Database

ORACLE/POSTGRESQL/MYSQL

Descrição de váriaveis de banco de dados, informações sobre migrations/schemas...