[![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] [![MIT License][license-shield]][license-url] [![LinkedIn][linkedin-shield]][linkedin-url]

Logo

project_title

project_description
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements
## About The Project [![Product Name Screen Shot][product-screenshot]](https://example.com) Here's a blank template to get started: **To avoid retyping too much info. Do a search and replace with your text editor for the following:** `github_username`, `repo_name`, `twitter_handle`, `email`, `project_title`, `project_description` ### Built With * []() * []() * []() ## Getting Started To get a local copy up and running follow these simple steps. ### Prerequisites This is an example of how to list things you need to use the software and how to install them. * npm ```sh npm install npm@latest -g ``` ### Installation 1. Clone the repo ```sh git clone https://github.com/github_username/repo_name.git ``` 2. Install NPM packages ```sh npm install ``` ## 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](https://example.com)_ ## Roadmap See the [open issues](https://github.com/github_username/repo_name/issues) 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 ## License Distributed under the MIT License. See `LICENSE` for more information. ## Contact Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email Project Link: [https://github.com/github_username/repo_name](https://github.com/github_username/repo_name) ## Acknowledgements * []() * []() * []() [contributors-shield]: https://img.shields.io/github/contributors/github_username/repo.svg?style=for-the-badge [contributors-url]: https://github.com/github_username/repo/graphs/contributors [forks-shield]: https://img.shields.io/github/forks/github_username/repo.svg?style=for-the-badge [forks-url]: https://github.com/github_username/repo/network/members [stars-shield]: https://img.shields.io/github/stars/github_username/repo.svg?style=for-the-badge [stars-url]: https://github.com/github_username/repo/stargazers [issues-shield]: https://img.shields.io/github/issues/github_username/repo.svg?style=for-the-badge [issues-url]: https://github.com/github_username/repo/issues [license-shield]: https://img.shields.io/github/license/github_username/repo.svg?style=for-the-badge [license-url]: https://github.com/github_username/repo/blob/master/LICENSE.txt [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 [linkedin-url]: https://linkedin.com/in/github_username [product-screenshot]: images/screenshot.png