[[top]]

https://github.com/github_username/repo_name/graphs/contributors[image:https://img.shields.io/github/contributors/github_username/repo_name.svg?style=for-the-badge[Contributors]]
https://github.com/github_username/repo_name/network/members[image:https://img.shields.io/github/forks/github_username/repo_name.svg?style=for-the-badge[Forks]]
https://github.com/github_username/repo_name/stargazers[image:https://img.shields.io/github/stars/github_username/repo_name.svg?style=for-the-badge[Stargazers]]
https://github.com/github_username/repo_name/issues[image:https://img.shields.io/github/issues/github_username/repo_name.svg?style=for-the-badge[Issues]]
https://github.com/github_username/repo_name/blob/master/LICENSE.txt[image:https://img.shields.io/github/license/github_username/repo_name.svg?style=for-the-badge[MIT
License]]
https://linkedin.com/in/linkedin_username[image:https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555[LinkedIn]]

project_title

project_description Explore the docs » View Demo · Report Bug · Request
Feature

Table of Contents

About The Project

Built With

Getting Started

Prerequisites

Installation

Usage

Roadmap

Contributing

License

Contact

Acknowledgments

== About The Project

https://example.com[image:images/screenshot.png[Product Name Screen
Shot]]

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`, `linkedin_username`,
`email_client`, `email`, `project_title`, `project_description`

(back to top)

=== Built With

* https://nextjs.org/[Next.js]
* https://reactjs.org/[React.js]
* https://vuejs.org/[Vue.js]
* https://angular.io/[Angular]
* https://svelte.dev/[Svelte]
* https://laravel.com[Laravel]
* https://getbootstrap.com[Bootstrap]
* https://jquery.com[JQuery]

(back to top)

== 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 `sh   npm install npm@latest -g`

=== Installation

[arabic]
. Get a free API Key at https://example.com
. Clone the repo
+
[source,sh]
----
git clone https://github.com/github_username/repo_name.git
----
. Install NPM packages
+
[source,sh]
----
npm install
----
. Enter your API in `config.js`
+
[source,js]
----
const API_KEY = 'ENTER YOUR API';
----

(back to top)

== 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
https://example.com[Documentation]_

(back to top)

== Roadmap

* ☐ Feature 1
* ☐ Feature 2
* ☐ Feature 3
** ☐ Nested Feature

See the https://github.com/github_username/repo_name/issues[open issues]
for a full list of proposed features (and known issues).

(back to top)

== Contributing

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

If you have a suggestion that would make this better, please fork the
repo and create a pull request. You can also simply open an issue with
the tag ``enhancement''. Don’t forget to give the project a star! Thanks
again!

[arabic]
. Fork the Project
. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
. Push to the Branch (`git push origin feature/AmazingFeature`)
. Open a Pull Request

(back to top)

== License

Distributed under the MIT License. See `LICENSE.txt` for more
information.

(back to top)

== Contact

Your Name - https://twitter.com/twitter_handle[@twitter_handle] -
email@email_client.com

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

(back to top)

== Acknowledgments

* link:[]
* link:[]
* link:[]

(back to top)
