<ProductName_ComponentName> Repository

This line gives a short description of what the repository holds.

Eg: Flutter is Google's SDK for crafting beautiful, fast user experiences for mobile, web and desktop from a single codebase. Flutter works with existing code, is used by developers and organizations around the world, and is free and open source.

Table of Contents

• Installation
• Libraries
• Deployment
• Features
• Testing
• Contribution
• FAQs

Installation

Clone

List the cloning steps here

Configuration

Specify the config details if any (hardware/software reqs)

• Software config if any
• Database config
• Hardware config if any

Local Setup

• Ubuntu Ubuntu specific setup details here

• Mac Mac specific setup details here

• Windows Windows specific setup details here

Cloud Specific Setup

• AWS AWS specific setup details here

• GCP GCP specific setup details here

• Azure Azure specific setup details here

• Android Playstore Playstore specific setup details here

• Apple Appstore Apple Appstore specific setup details here

Deployment Instructions

List the deployment steps here

Libraries

List of common libs used (OSS/paid/...)

• OSS
• Paid/Licensed

Features

List the high-level features that repo builds

• Feature1
• Feature2

Testing

• Tests list link
• How to run tests

Contribution

• Writing tests
• Code review / raising PRs
• Other guidelines

FAQs

List the commonly asked questions regarding repo here