Name of Project

[SHORT DESCRIPTOR OF PROJECT, TAGLINE]

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. Contact
7. Acknowledgements

About The Project

[LONGER DESCRIPTION OF PROJECT. WHAT AND THE WHY]

Here's why:

• REASON 1
• REASON 2
• REASON 3

Built With

• Typescript
• React
• Webpack
• Babel
• Node

Getting Started

USEFUL INFORMATION TO GET STARTED. EXAMPLE TEMPLATE BELOW.

Prerequisites

• NVM: Node Version Manager
  • Node >= 15.2.1
  • NPM >= 7.0.8

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 .env based off config.example.txt.

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

See the LINK TO OPEN ISSUES PAGE FOR REPO for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Your Name - LINK TO SOCIALS - LINK TO WEBSITE

Project Link: https://github.com/your_username/repo_name

Acknowledgements

• LINKS TO
• Img Shields
• Choose an Open Source License
• GitHub Pages
• Animate.css
• Loaders.css
• Slick Carousel
• Smooth Scroll
• Sticky Kit
• JVectorMap
• Font Awesome