project readme template

readme.md

Project documentation (Readme.md)

Why?

• Onboarding readiness
• Inner sourcing
• Efficiency in changing contexts between projects
• Reduce cognitive load

How it works

Every github repository must have a README.md. This documentation should include some required sections and info, but you are free to add any other custom section that you should consider important for the project understanding.

Badges:

• Github Actions Badge
• Jenkins Badge

Please, follow the example below:

# Project Name [![Jenkins/GithubActions Badge](link for Jenkins/GithubActions badge)

Here we need to provide some info about the project purpose.

## Architecture

Here we can show:
 - Diagrams to illustrate the aim of this project (http://draw.io/);
 - Any info related to chosen programming language(s) and framework(s);
 - Related projects and dependency projects .

## Application Checklist

 - [X] [API Docs](link to the live API Docs - https://swagger.io/)
 - [X] [Code Quality](link to the code quality tool - sonar)
 - [X] [Monitoring dashboards](link to the monitoring dashboards for the application)
 - [X] [Logs](link to graylog filtering for your application)
 - [X] [CI/CD](link to your CI/CD steps)

## How to Run

 What is necessary to run this project locally?

## How to Test

Which requirements are needed to test this project? Does it have a docker-compose? Does it have any automated test (unit, integration or others)?

## How to Deploy

Is the deploy done manually or continuously? How does it work? Are there any links that would help to understand how it works?