Sugestão de um bom README em português para você usar em seu projeto interno ou OpenSource

README_campeao.md

nome_do_projeto

descricao_do_projeto

Esse projeto foi criado por <NOME_DO_TIME ou NOME_DAS_PESSOAS>

Contexto

Note Uma descrição do serviço, por exemplo: "project_name é um serviço de..."

Que problema(s) tenta resolver?

Note Descrever com detalhes o que este serviço está tentando resolver

Principais funcionalidades

Note Descrever quais as principais funcionalidades do serviço

Arquitetura

Note Existem processos, serviços ou componentes envolvidos? Como eles se encaixam? Existem requisitos ambientais (AWS) ou de apoio (Kafka, Zookeeper)?

Diagramas são bem-vindos aqui. Busque usar a integração entre Github e Mermaid

  graph TD;
      A-->B;
      A-->C;
      B-->D;
      C-->D;

Loading

Escopo do serviço

Este serviço é indicado para:

Note Em que circunstâncias este serviço é adequado? Por que?

Este serviço NÃO é indicado para:

Note Em que circunstâncias este serviço não é adequado? Por que?

Alternativas

Note Existem serviços alternativos no mesmo espaço? O que os difere?

Outras características relevantes

Note Liste aspectos operacionais (latência, escalabilidade, segurança) que devem ser destacados

Recursos

Note Links externos, documentações, referências etc

Execução do projeto e configuração de ambiente

Requisitos

• Fastify ^4.3.0
• Node.js 16 LTS or later

Code Style

• Check TypeScript Code Style Best Practices Recommendations

Linting

List issues

$ yarn lint

Fix issues

$ yarn lint:fix

Testing

Run all tests:

$ yarn test

Run autotest

$ yarn test:watch

Unit tests

$ yarn unit

Integration tests

$ yarn integration

Running

$ git clone git@github.com:flash-tecnologia/project_name.git
$ cd project_name
$ yarn
$ yarn dev

If everything went well you can play here -> http://localhost:3000/docs

README_minimo.md

nome_do_projeto

descricao_do_projeto

Execução do projeto e configuração de ambiente

Requisitos

• Fastify ^4.3.0
• Node.js 16 LTS or later

Code Style

• Check TypeScript Code Style Best Practices Recommendations

Linting

List issues

$ yarn lint

Fix issues

$ yarn lint:fix

Testing

Run all tests:

$ yarn test

Run autotest

$ yarn test:watch

Unit tests

$ yarn unit

Integration tests

$ yarn integration

Running

$ git clone git@github.com:flash-tecnologia/project_name.git
$ cd project_name
$ yarn
$ yarn dev

If everything went well you can play here -> http://localhost:3000/docs

README_ok.md

nome_do_projeto

descricao_do_projeto

Esse projeto foi criado por <NOME_DO_TIME ou NOME_DAS_PESSOAS>

Principais funcionalidades

Note Descrever quais as principais funcionalidades do serviço

Arquitetura

Note Existem processos, serviços ou componentes envolvidos? Como eles se encaixam? Existem requisitos ambientais (AWS) ou de apoio (Kafka, Zookeeper)?

Diagramas são bem-vindos aqui. Busque usar a integração entre Github e Mermaid

  graph TD;
      A-->B;
      A-->C;
      B-->D;
      C-->D;

Loading

Outras características relevantes

Note Liste aspectos operacionais (latência, escalabilidade, segurança) que devem ser destacados

Recursos

Note Links externos, documentações, referências etc

Execução do projeto e configuração de ambiente

Requisitos

• Fastify ^4.3.0
• Node.js 16 LTS or later

Code Style

• Check TypeScript Code Style Best Practices Recommendations

Linting

List issues

$ yarn lint

Fix issues

$ yarn lint:fix

Testing

Run all tests:

$ yarn test

Run autotest

$ yarn test:watch

Unit tests

$ yarn unit

Integration tests

$ yarn integration

Running

$ git clone git@github.com:flash-tecnologia/project_name.git
$ cd project_name
$ yarn
$ yarn dev

If everything went well you can play here -> http://localhost:3000/docs