README-Template

A One line description of the project!
Explore the docs »

View Demo · Report Bug · Project documents

About The Project

![Optional Project Screen Shot][product-screenshot]

Long description of the project.

Built With

This section should list any major frameworks that you built your project using. Here are a few examples.

• List all main libraries used. Only list Major libraries and not minor ones. (ex. don't list a calendar library that you are using)

Project Initiation

Below are key readings before working on any project:

• Contributing to this repository
• How we write issues
• Our project workflow

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Get a free API Key at https://example.com
2. Clone the repo

   git clone https://github.com/your_username_/Project-Name.git

3. Install NPM packages

   npm install

4. Enter your API in config.js

   const API_KEY = 'ENTER YOUR API';

Development

Add important instructions and links like:

• Design link.
• Important Dependencies and plugins...

Deployment

Add deployment instructions and important links in here.

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

Link to Project Road Map either jira or zenHub or any other platform.

Contact

Project Manager:

• Name - @your_twitter - email@example.com

Team Leader:

• Name - @your_twitter - email@example.com

Partner Company Representative:

• Name - @your_twitter - email@example.com