├── 6 - Extra.md ├── assets ├── bg-1.jpg ├── bg-2.jpg ├── bg-3.webp └── chatBot.png ├── 1 - Introduction.md ├── 3 - TechStack & Source.md ├── 5 - Contribution - Issues - End.md ├── 2 - Overview & Feature.md ├── 4 - Getting Started & Installation.md └── Readme.md /6 - Extra.md: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /assets/bg-1.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Sumonta056/Readme-Template/HEAD/assets/bg-1.jpg -------------------------------------------------------------------------------- /assets/bg-2.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Sumonta056/Readme-Template/HEAD/assets/bg-2.jpg -------------------------------------------------------------------------------- /assets/bg-3.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Sumonta056/Readme-Template/HEAD/assets/bg-3.webp -------------------------------------------------------------------------------- /assets/chatBot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Sumonta056/Readme-Template/HEAD/assets/chatBot.png -------------------------------------------------------------------------------- /1 - Introduction.md: -------------------------------------------------------------------------------- 1 |
2 | 3 | Logo 4 | 5 | 6 |

Project Name : Readme Template

7 | 8 | ![](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white) 9 | ![](https://img.shields.io/badge/Next.js-000000?style=for-the-badge&logo=next.js&logoColor=white) 10 | ![](https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white) 11 | ![](https://img.shields.io/badge/React-61DAFB?style=for-the-badge&logo=react&logoColor=black) 12 | ![](https://img.shields.io/badge/Prisma-3982CE?style=for-the-badge&logo=Prisma&logoColor=white) 13 | ![](https://img.shields.io/badge/Radix_UI-6200EE?style=for-the-badge&logo=radix-ui&logoColor=white) 14 | 15 | 16 | 17 |
-------------------------------------------------------------------------------- /3 - TechStack & Source.md: -------------------------------------------------------------------------------- 1 | ## 👩‍💻 Tech Stack 2 | 3 | - **Next.js**: A React framework for building server-side rendering and static web applications. 4 | - **Auth.js**: Free and open source Authentication for the Web. 5 | - **Hono**: A lightweight web framework for building server-side applications with TypeScript. 6 | - **Drizzle ORM**: TypeScript-first ORM for type-safe database access. 7 | - **React Query**: Data-fetching library for managing server-state in React applications. 8 | - **Bun**: A fast JavaScript runtime that includes a package manager, task runner, and more. 9 | 10 | ## 📖 Sources and external API's 11 | 12 | - [quran-json](https://github.com/risan/quran-json) to get the text of the quran in different languages 13 | - [everyayah](https://everyayah.com) to get the audio each aya 14 | - [quran-tafseer](http://api.quran-tafseer.com/en/docs) to get the tafseer 15 | - [explorequran](https://www.explorequran.org) random ayah source -------------------------------------------------------------------------------- /5 - Contribution - Issues - End.md: -------------------------------------------------------------------------------- 1 | ## 🤝 Contributing 2 | 3 | We welcome contributions to this project. Please follow these steps to contribute: 4 | 5 | 1. **Fork the repository.** 6 | 2. **Create a new branch** (`git checkout -b feature/your-feature-name`). 7 | 3. **Make your changes** and commit them (`git commit -m 'Add some feature'`). 8 | 4. **Push to the branch** (`git push origin feature/your-feature-name`). 9 | 5. **Open a pull request**. 10 | 11 | Please make sure to update tests as appropriate. 12 | 13 | ## 🐛 Issues 14 | 15 | If you encounter any issues while using or setting up the project, please check the [Issues](https://github.com/mo-hassann/nextjs-quran-app/issues) section to see if it has already been reported. If not, feel free to open a new issue detailing the problem. 16 | 17 | When reporting an issue, please include: 18 | 19 | - A clear and descriptive title. 20 | - A detailed description of the problem. 21 | - Steps to reproduce the issue. 22 | - Any relevant logs or screenshots. 23 | - The environment in which the issue occurs (OS, browser, Node.js version, etc.). 24 | 25 | ## 📜 License 26 | 27 | Distributed under the MIT License. See [License](/LICENSE) for more information. -------------------------------------------------------------------------------- /2 - Overview & Feature.md: -------------------------------------------------------------------------------- 1 | ## 💡 Overview 2 | 3 | FixHub is a powerful and intuitive issue tracker built using Next.js and SQL, designed to streamline bug management and project tracking. With a focus on efficiency and user-friendliness, FixHub allows for seamless creation, viewing, updating, and deletion of issues. Key features include: 4 | 5 | ## ✨ Features 6 | 7 | - **🔐 User Authentication and Access Control:** Secure login and personalized access levels ensure that only authorized users can manage or view issues. 8 | - **🌍 Issue Assignment:** Creating, Viewing, Updating and Deleting Issues. Assign tasks to team members effortlessly, keeping everyone accountable and informed. 9 | - **🔍 Advanced Filtering & Sorting:** Easily filter and sort issues to quickly find and prioritize tasks. 10 | - **📄 Pagination & Analytics:** Navigate through large lists of issues with pagination and gain insights with charts and a comprehensive dashboard. 11 | - **🎯 Production-Ready Optimization:** Built for speed and reliability, FixHub is optimized for production environments, ensuring smooth performance at scale. 12 | - **🔧 Customization & Flexibility:** Tailor FixHub to your needs with customizable settings and configurations. 13 | - **📱 Responsive Design:** Access FixHub on any device with a responsive design that adapts to various screen sizes. 14 | 15 | Whether you're a solo developer or part of a large team, FixHub is the perfect tool for tracking and resolving issues with ease.🐞 -------------------------------------------------------------------------------- /4 - Getting Started & Installation.md: -------------------------------------------------------------------------------- 1 | ## 📦 Getting Started 2 | 3 | To get a local copy of this project up and running, follow these steps. 4 | 5 | ### 🚀 Prerequisites 6 | 7 | - **Node.js** (v16.x or higher) and **npm** or **yarn**. 8 | - **Npm**: If you prefer using npm for package management and running scripts. 9 | - **PostgreSQL** (or another supported SQL database). 10 | 11 | ## 🛠️ Installation 12 | 13 | 1. **Clone the repository:** 14 | 15 | ```bash 16 | git clone https://github.com/mo-hassann/nextjs-quran-app.git 17 | cd nextjs-quran-app 18 | ``` 19 | 20 | 2. **Install dependencies:** 21 | 22 | Using Npm: 23 | 24 | ```bash 25 | npm install 26 | ``` 27 | 28 | 3. **Set up environment variables:** 29 | 30 | Create a `.env` file in the root directory and add the following variables: 31 | 32 | ```env 33 | NEXT_PUBLIC_APP_URL=http://localhost:3000 34 | 35 | #database 36 | DATABASE_URL=your_database_url 37 | DATABASE_SECRET=your_database_secret 38 | DRIZZLE_DATABASE_URL=your_database_url_for_drizzle 39 | 40 | #auth 41 | AUTH_SECRET=any_random_secret 42 | ``` 43 | 44 | 4. **Run database migrations:** 45 | 46 | Ensure your database is running and then run: 47 | 48 | ```bash 49 | npm run drizzle-kit migrate 50 | ``` 51 | 52 | 5. **Start the development server:** 53 | 54 | ```bash 55 | npm run dev 56 | ``` 57 | 58 | Open [http://localhost:3000](http://localhost:3000) to view the app in your browser. 59 | 60 | ## 📖 Usage 61 | 62 | ### ✔ Running the app 63 | 64 | - **Development mode:** `npm run dev`, `yarn dev`, or `bun dev`. 65 | - **Production mode:** `npm run build && npm start`, `yarn build && yarn start`, or `bun run build && bun start`. 66 | 67 | Open [http://localhost:3000](http://localhost:3000) to view the app in your browser. 68 | 69 | ### 🔥 API Documentation 70 | 71 | The API documentation for this application is available at [http://localhost:3000/api/docs](http://localhost:3000/api/docs). It details all endpoints and their usage. -------------------------------------------------------------------------------- /Readme.md: -------------------------------------------------------------------------------- 1 |
2 | 3 | ⭐ **If you like this project, please star the repository!** ⭐
4 | ------- 👇 **Template Demo Below** 👇 -------- 5 | 6 |
7 |
8 | 9 |
10 | 11 | Logo 12 | 13 | 14 |

Project Name : Readme Template

15 | 16 | ![](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white) 17 | ![](https://img.shields.io/badge/Next.js-000000?style=for-the-badge&logo=next.js&logoColor=white) 18 | ![](https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white) 19 | ![](https://img.shields.io/badge/React-61DAFB?style=for-the-badge&logo=react&logoColor=black) 20 | ![](https://img.shields.io/badge/Prisma-3982CE?style=for-the-badge&logo=Prisma&logoColor=white) 21 | ![](https://img.shields.io/badge/Radix_UI-6200EE?style=for-the-badge&logo=radix-ui&logoColor=white) 22 | 23 | 24 | 25 |
26 | 27 | ## 💡 Overview 28 | 29 | FixHub is a powerful and intuitive issue tracker built using Next.js and SQL, designed to streamline bug management and project tracking. With a focus on efficiency and user-friendliness, FixHub allows for seamless creation, viewing, updating, and deletion of issues. Key features include: 30 | 31 | ## ✨ Features 32 | 33 | - **🔐 User Authentication:** Secure login with personalized access levels. 34 | - **🌍 Issue Management:** Create, view, update, and delete issues; assign tasks to team members. 35 | - **🔍 Filtering & Sorting:** Advanced options to quickly find and prioritize tasks. 36 | - **📄 Pagination & Analytics:** Navigate large lists and gain insights with charts and dashboards. 37 | - **🎯 Production Optimization:** Built for speed and reliability in production environments. 38 | - **🔧 Customization:** Tailor settings and configurations to your needs. 39 | - **📱 Responsive Design:** Access on any device with adaptive design. 40 | 41 | Whether you're a solo developer or part of a large team, FixHub is the perfect tool for tracking and resolving issues with ease.🐞 42 | 43 | ## 👩‍💻 Tech Stack 44 | 45 | - **Next.js**: A React framework for building server-side rendering and static web applications. 46 | - **Auth.js**: Free and open source Authentication for the Web. 47 | - **Hono**: A lightweight web framework for building server-side applications with TypeScript. 48 | - **Drizzle ORM**: TypeScript-first ORM for type-safe database access. 49 | - **React Query**: Data-fetching library for managing server-state in React applications. 50 | - **Npm Package**: A fast JavaScript runtime that includes a package manager, task runner, and more. 51 | 52 | ## 📖 Sources and external API's 53 | 54 | - [NASA](https://www.nasa.gov) for space exploration and research 55 | - [National Geographic](https://www.nationalgeographic.com) for nature and science articles 56 | - [Stack Overflow](https://stackoverflow.com) for programming questions and answers 57 | - [Wikipedia](https://www.wikipedia.org) for a wide range of information on various topics 58 | 59 | ## 📦 Getting Started 60 | 61 | To get a local copy of this project up and running, follow these steps. 62 | 63 | ### 🚀 Prerequisites 64 | 65 | - **Node.js** (v16.x or higher) and **npm** or **yarn**. 66 | - **Npm** If you prefer using npm for package management and running scripts. 67 | - **PostgreSQL** (or another supported SQL database). 68 | 69 | ## 🛠️ Installation 70 | 71 | 1. **Clone the repository:** 72 | 73 | ```bash 74 | git clone https://github.com/sumonta056/readme-template.git 75 | cd readme-template 76 | ``` 77 | 78 | 2. **Install dependencies:** 79 | 80 | Using Npm: 81 | 82 | ```bash 83 | npm install 84 | ``` 85 | 86 | 3. **Set up environment variables:** 87 | 88 | Create a `.env` file in the root directory and add the following variables: 89 | 90 | ```env 91 | NEXT_PUBLIC_APP_URL=http://localhost:3000 92 | 93 | #database 94 | DATABASE_URL=your_database_url 95 | DATABASE_SECRET=your_database_secret 96 | DRIZZLE_DATABASE_URL=your_database_url_for_drizzle 97 | 98 | #auth 99 | AUTH_SECRET=any_random_secret 100 | ``` 101 | 102 | 4. **Run database migrations:** 103 | 104 | Ensure your database is running and then run: 105 | 106 | ```bash 107 | npm run drizzle-kit migrate 108 | ``` 109 | 110 | 5. **Start the development server:** 111 | 112 | ```bash 113 | npm run dev 114 | ``` 115 | 116 | ## 📖 Usage 117 | 118 | ### ✔ Running the Website 119 | 120 | - **Development mode:** `npm run dev`, `yarn dev`, or `bun dev`. 121 | - **Production mode:** `npm run build && npm start`, `yarn build && yarn start`, or `bun run build && bun start`. 122 | 123 | > Open [http://localhost:3000](http://localhost:3000) to view the app in your browser. 124 | 125 | ### 📃 API Documentation 126 | 127 | The API documentation for this application is available at [http://localhost:3000/api/docs](http://localhost:3000/api/docs). It details all endpoints and their usage. 128 | 129 | ## 🤝 Contributing 130 | 131 | We welcome contributions to this project. Please follow these steps to contribute: 132 | 133 | 1. **Fork the repository.** 134 | 2. **Create a new branch** (`git checkout -b feature/your-feature-name`). 135 | 3. **Make your changes** and commit them (`git commit -m 'Add some feature'`). 136 | 4. **Push to the branch** (`git push origin feature/your-feature-name`). 137 | 5. **Open a pull request**. 138 | 139 | Please make sure to update tests as appropriate. 140 | 141 | ## 🐛 Issues 142 | 143 | If you encounter any issues while using or setting up the project, please check the [Issues]() section to see if it has already been reported. If not, feel free to open a new issue detailing the problem. 144 | 145 | When reporting an issue, please include: 146 | 147 | - A clear and descriptive title. 148 | - A detailed description of the problem. 149 | - Steps to reproduce the issue. 150 | - Any relevant logs or screenshots. 151 | - The environment in which the issue occurs (OS, browser, Node.js version, etc.). 152 | 153 | ## 📜 License 154 | 155 | Distributed under the MIT License. See [License](/LICENSE) for more information. 156 | --------------------------------------------------------------------------------