Create README.md

README.md

@@ -0,0 +1,161 @@
+
+[![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]
+
+
+
+<!-- PROJECT LOGO -->
+<br />
+<p align="center">
+  <a href="https://github.com/muttakinhasib/aafiyah">
+    <img src="https://aafiyah.vercel.app/aafiyah-logo.svg" alt="" width="90" height="90">
+  </a>
+
+  <p align="center">
+   An Islamic E-Commerce Web Application using REST API, Nest.js, typeORM and PostgreSQL
+    <br />
+    <a href="https://github.com/muttakinhasib/aafiyah"><strong>Explore the docs »</strong></a>
+    <br />
+    <br />
+    <a href="https://aafiyah.vercel.app">View Demo</a>
+    ·
+    <a href="https://github.com/muttakinhasib/aafiyah/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/muttakinhasib/aafiyah/issues">Request Feature</a>
+  </p>
+</p>
+
+
+
+<!-- TABLE OF CONTENTS
+<details open="open">
+  <summary>Table of Contents</summary>
+  <ol>
+    <li>
+      <a href="#about-the-project">About The Project</a>
+      <ul>
+        <li><a href="#built-with">Built With</a></li>
+      </ul>
+    </li>
+<li>
+      <a href="#getting-started">Getting Started</a>
+      <ul>
+        <li><a href="#prerequisites">Prerequisites</a></li>
+        <li><a href="#installation">Installation</a></li>
+      </ul>
+    </li> 
+    <li><a href="#contributing">Contributing</a></li>
+    <li><a href="#license">License</a></li>
+    <li><a href="#contact">Contact</a></li>
+  </ol>
+</details>
+ -->
+
+
+<!-- ABOUT THE PROJECT
+## About The Project
+
+One of the best Al Quran Desktop applications for macOS, Windows... with Dark & Light Mode
+
+### Light Mode : 
+
+![Light Mode Home Page Al Quran](https://user-images.githubusercontent.com/44552983/103951424-d9f39500-5168-11eb-9fea-4851447cc317.png)
+
+![Al Quran Light Mode Verse Page](https://user-images.githubusercontent.com/44552983/103951591-2dfe7980-5169-11eb-9c8c-0f556a2365e4.png)
+
+### Dark Mode :
+
+![Al Quran Dark Mode Home Page](https://user-images.githubusercontent.com/44552983/103951681-5be3be00-5169-11eb-81ef-4fbbecf2130c.png)
+
+![Al Quran Dark Mode Verse Page](https://user-images.githubusercontent.com/44552983/103951765-7d44aa00-5169-11eb-88e4-5a164603a1c2.png)
+ -->
+
+### Built With
+
+This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.
+* [React](https://reactjs.org/)
+* [Electron](https://www.electronjs.org/)
+* [TailwindCSS](tailwindcss.com/)
+
+
+
+<!-- GETTING STARTED -->
+## 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
+
+1. Clone the repo
+   ```sh
+   git clone https://github.com/muttakinhasib/aafiyah.git
+   ```
+2. Clone the private repo (API)
+   ```sh
+   git submodule update --init
+   ```
+2. Install NPM packages
+   ```sh
+   npm install
+   ```
+   or
+    ```sh
+    yarn
+   ```
+
+
+<!-- CONTRIBUTING -->
+## 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 -->
+## License
+
+Distributed under the MIT License. See `LICENSE` for more information.
+
+
+
+<!-- CONTACT -->
+## Contact
+
+[Hasib](https://facebook.com/muttakinhasib) - [email protected]
+
+Project Link: [https://github.com/muttakinhasib/aafiyah](https://github.com/muttakinhasib/aafiyah)
+
+
+
+
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+[contributors-shield]: https://img.shields.io/github/contributors/MuttakinHasib/Al-Quran.svg?style=for-the-badge
+[contributors-url]: https://github.com/muttakinhasib/aafiyah/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/MuttakinHasib/Al-Quran.svg?style=for-the-badge
+[forks-url]: https://github.com/muttakinhasib/aafiyah/network/members
+[stars-shield]: https://img.shields.io/github/stars/MuttakinHasib/Al-Quran.svg?style=for-the-badge
+[stars-url]: https://github.com/muttakinhasib/aafiyah/stargazers
+[issues-shield]: https://img.shields.io/github/issues/MuttakinHasib/Al-Quran.svg?style=for-the-badge
+[issues-url]: https://github.com/muttakinhasib/aafiyah/issues
+[license-shield]: https://img.shields.io/github/license/MuttakinHasib/Al-Quran.svg?style=for-the-badge
+[license-url]: https://github.com/muttakinhasib/aafiyah/blob/master/LICENSE.txt
+