---

Name of the project

Additional information or tag line

A brief description of your project, what it is used for.

^{Table of Contents}

DOCUMENTATION
Code of Conduct
Code Reviewers
Help Contribute
Dev Guidelines
License Details

• Name of the project
  • Table of Contents
  • Getting Started
    • Installation
  • Configuration
    • Artifactory
    • Environment variables
  • Developing
    • Built With
    • Prerequisites
    • Setting up Dev
  • Maintinence
  • Testing
    • Building
  • Versioning
    • Deploying / Publishing

---

_{Getting Started}

A quick introduction of the minimal setup you need to get a hello world up & running.

commands here

You should say what actually happens when you execute the code above.

^Installation

Include steps to install any prerequisits

🔝

_{Configuration}

Below is a configuration check to ensure each expected variable is defined and passed as a configuration export.

^Artifactory

Include configurations to pull packages from a private Artifactory if avaliable

^{Environment variables}

Include environment variables that aren't included in project (or where to find them)

🔝

_Developing

^{Built With}

List main libraries, frameworks used including versions (React, Angular etc...)

^{Prerequisites}

What is needed to set up the dev environment. For instance, global dependencies or any other tools. include download links.

^{Setting up Dev}

Here's a brief intro about what a developer must do in order to start developing the project further:

git clone https://github.com/your/your-project.git
cd your-project/
packagemanager install

State what happens step-by-step. If there is any virtual environment, local server or database feeder needed, explain here.

🔝

_Maintinence

Provide details on avaliable tools for maintaining project

_Testing

Describe and show how to run the tests with code examples. Explain what these tests test and why.

Give an example

_Building

If your project needs some additional steps for the developer to build the project after some code changes, state them here. for example:

./configure
make
make install

State what actually happens when the code above gets executed.

🔝

_Versioning

Explain the versioning process and any type of automation this entails

^{Deploying / Publishing}

give instructions on how to build and release a new version In case there's some step you have to take that publishes this project to a server, this is the right time to state it.

packagemanager deploy your-project -s server.com -u username -p password

Tell what the previous code actually does.

---

^_DOCS   Code of Conduct • Code Reviewers • Help Contribute • Dev Guidelines • License Details