Skip to content

nabil-hfz/kawtharuna

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🌐 Kawtharuna System

📱 Kawtharuna Android Application:

Get it on Google Play

🌟 Current Features

Backend Frontend Mobile
Provides Quran audio files.
  • Lists all Quran audio files.
  • Runs Quran audio files.
  • Downloads Quran audio files.
  • Lists all Quran audio files.
  • Runs Quran audio files.
  • Downloads Quran audio files.
  • Provides Islamic reach Library
  • Provides search options
  • Downloads files
  • Lists files from the library
  • Provides files categories
  • Provides search options
  • Downloads Quran audio files
  • Lists files from the library
  • Provides files categories
  • Provides search options
  • Downloads Quran audio files

📚 System Components

  1. Backend: Built with Node.js using the Express framework in TypeScript.
  2. Mobile App: Built with the Flutter framework for Android & iOS.
  3. Frontend: Built with Angular.

💡 Contributions

We are excited to welcome contributions to the Kawtharuna project! Whether you're fixing bugs, improving documentation, or adding new features, your help is greatly appreciated. Contributing is also a great way to learn more about coding, collaboration, and open-source development.

🌟 First-Time Contributors

We welcome first-time contributors and strive to provide a welcoming and supportive environment. If you're not sure where to start, look for issues tagged with good-first-issue or help-wanted.

🚀 How to Contribute

  1. Fork the Repository: Start by forking the repository to your GitHub account.
  2. Clone the Forked Repository: Clone your forked version to your local machine.
  3. Create a New Branch: For each new feature or fix, create a separate branch.
  4. Make Your Changes: Implement your feature or fix and commit your changes.
  5. Test Your Changes: Ensure your changes do not break any existing functionality.
  6. Submit a Pull Request: Push your changes to your fork and open a pull request against the main Kawtharuna repository.

📝 Contribution Guidelines

  • Follow Best Practices: Write clean, maintainable, and efficient code.
  • Respect Coding Conventions: Adhere to the coding style and guidelines of the project.
  • Document Your Changes: Provide clear and meaningful commit messages and pull request descriptions.
  • Be Respectful: Interact with other contributors respectfully and professionally.

🛠️ Creating Your Kawtharuna Application

We welcome all developers to use our API and source code to create applications on the Kawtharuna platform. However, we have a few requirements:

  • Naming: Please do not use the name "Kawtharuna" for your app, or ensure your users understand that it is unofficial.
  • Logo: Do not use our standard logo (white paper plane in a blue circle) as your app's logo.
  • Open Source Compliance: If you're using our GPL-2.0-licensed code, remember to also publish your code to comply with the GPL-2.0 license.