π₯οΈ Kawtharuna Website
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.
Backend | Frontend | Mobile |
---|---|---|
Provides Quran audio files. |
|
|
|
|
|
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.
- Fork the Repository: Start by forking the repository to your GitHub account.
- Clone the Forked Repository: Clone your forked version to your local machine.
- Create a New Branch: For each new feature or fix, create a separate branch.
- Make Your Changes: Implement your feature or fix and commit your changes.
- Test Your Changes: Ensure your changes do not break any existing functionality.
- Submit a Pull Request: Push your changes to your fork and open a pull request against the main Kawtharuna repository.
- 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.
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
.
- Backend: Built with Node.js using the Express framework in TypeScript.
- Mobile App: Built with the Flutter framework for Android & iOS.
- Frontend: Built with Angular.