Documentação de um arquivo só

README.md

Documentação [nome-do-projeto]

Setup do ambiente(exemplo)

• Usar a versão x.x.x do Node
• Instalar dependências
• Rodar yarn start ou npm run start para iniciar a aplicação

Arquitetura e premissas(exemplo)

A arquitetura desse projeto foi desenvolvida com base na arquitetura REST utilizando x, x e x. Em breve, a implementação de x poderá ser comtemplada para a feature de x.

Ponto importante: Regra de negócio imprescindível para o projeto/produto.

As pastas seguem a seguintes premissas(exemplo):

• /controller: Camada de regras de negócio e arquitetura de dados
• /downloads: Uploads do usuário, no padrão nomedoarquivo-iddousuario.tipo
• /helpers: Imagens para emails e outras coisas
• /libs: Funções e métodos reutilizáveis por todo o projeto
• /middlewares: Validações gerais para os controllers
• /models: Modelos de dados para o MongoDB
• /models/enums: Tipos, Status e informações reutilizáveis nas models
• /routes: Rotas da aplicação
• /services: Camada de contato direto com banco de dados
• /uploads: Uploads de arquivos próprios da plataforma. Ex: Políticas de privacidade, termos, etc..

Nomenclaturas usadas no código(exemplo)

• Investor: Usuário do tipo investidor
• Startup: Usuário do tipo startup
• Offer: A oferta de fato, com os valores e o usuário vinculado
• Like: Demonstração de interesse de uma parte na Offer
• Match: Interesse mútuo na Offer
• Negotiation: Após o match, os usuários começam uma negociação