An open-source implementation of the Quran mushaf in TypeScript using Next.js, serwist, and TailwindCSS.
- All mushaf pages are from the Quran Complex of King Fehd.
- Database (JSON) is from Mushaf-mauri.
- Tafaseer data is from Ayat.
- Icon from SVGRepo
- Offline access to Quran Mushaf pages.
- Responsive design optimized for both desktop and mobile.
- Multiple Tafseer (exegesis) options.
- Smooth navigation between Surahs and Juz.
- High-quality images sourced from the Quran Complex of King Fehd.
First, install the dependencies:
npm install
Important
Important: DO NOT commit this file to your version control system (e.g., Git) for security reasons.
Here's a basic guide on getting started with nextpalestine:
- Clone the repository: Use
git clone https://github.com/adelpro/open-mushaf.git
to clone the nextpalestine repository to your local machine. - Install dependencies: Navigate to the cloned directory and run
npm install
oryarn install
to install all the required dependencies. - Set up environment variables: Create a
.env
file in the project root directory and define any necessary environment variables (e.g., database connection string, API keys, use theenv.example
file as a template). Important: DO NOT commit this file to your version control system (e.g., Git) for security reasons. - Start the development server: Run
npm run dev
oryarn dev
to start the server. This will typically launch your application onhttp://localhost:3000
by default.
- Use the Issue Tracker: Go to the repository's issue tracker and create a new issue.
- Describe the Bug: Provide a clear and concise description of what the bug is.
- Steps to Reproduce: List the steps to reproduce the behavior.
- Expected Behavior: Describe what you expected to happen.
- Screenshots: If applicable, add screenshots to help explain your problem.
- Environment: Include details about your environment, like the browser version, Node.js version, etc.
- Submit an Issue: Open a new issue in the repository's issue tracker.
- Title: Give a concise and descriptive title for the enhancement.
- Detailed Description: Provide a detailed description of the proposed feature or enhancement.
- Additional Context: Add any other context or screenshots about the feature request.
- Fork the Repository: Fork the project to your own GitHub account.
- Create a Branch: Create a branch in your fork for your changes.
- Make Your Changes: Make the changes in your branch following the project's coding standards.
- Test Your Changes: Ensure that your changes do not break any existing functionality and that all tests pass.
- Write a Good Commit Message: Commit messages should be descriptive and mention the issue number if applicable.
- Submit a Pull Request (PR): Open a PR to the main repository with a clear title and description.
Contributions are welcome! Please fork this repository and submit a pull request. For major changes, please open an issue first to discuss what you would like to change.
This project is licensed under the MIT License - see the LICENSE file for details.
If you like this project, consider supporting me to continue developing and maintaining it!