app_default.md

Nome do Projeto

Breve descrição do projeto, como qual é a ideia geral dele e quais funcionalidades ele apresenta.

Ex.: O app Comunicados é utilizado para que a comunidade possa se comunicar mais facilmente com os seus integrantes. Ele pode ser usado tanto para visualização de seis diferentes tipos de post quanto para a publicação destes posts por parte da comunidade.

Estrutura do Projeto

Descrição de como o projeto está estruturado - o que é a pasta web? o que é a pasta app?

Ex.: O projeto está separado em duas pastas diferentes:

• web - contem os arquivos referentes ao front-end
• app - contem os arquivos referentes ao back-end

Pré-Requisitos

Descrição dos pré-requisitos necessários para a execução do projeto.

Ex.: Para executar, é necessário ter e utilizar a versão 12 do Node.js. Além disso, para ter acesso ao app dentro da plataforma da Layers é preciso que os repositórios App - Web, Backend e Layers ID estejam sendo executados

Instalação

Descrição de quais comandos devem ser executado para a instalação das dependências do projeto.

Ex.: Para instalação das dependências, é necessário executar os comandos dentro das pastas web e app respectivamente:

yarn install

Execução

Descrição de quais comandos são necessários para iniciar a execução do projeto. Ex.: Para iniciar o front-end, na pasta web, execute o comando:

# ./web
yarn start

Para iniciar o back-end, na pasta app, execute o comando:

# ./app
yarn start

Fontes Externas

Espaço para inserir links externos para a documentação da API de terceiros ou outras informações relevantes para os projetos.

Ex.:

• URL da API - https://inteiro.api.com/dados

• Documentação da Integração Inteiro - https://portal.inteiro.com.br/inteirowebapi/swagger/index.html