Skip to content

Latest commit

 

History

History

frontend

README.md

🌐 Kawtharuna Frontend - Angular (Status - 70% Done)

For more information about the Kawtharuna System and to use the application, visit our website.

🚀 Getting Started with Kawtharuna Frontend

This is the frontend part of the Kawtharuna System, built using Angular. It provides a rich, interactive web interface for accessing Quranic and Islamic library resources.

📚 Features

  • Quranic Files:

    • List all Quran audio files.
    • Play Quran audio files.
    • Download Quran audio files.

  • Islamic Files Library:

    • List files from the library.
    • Provide file categories.
    • Offer search options.
    • Download Islamic files.

🛠️ Development Setup

To get started with development, follow these steps:

  1. Clone the Repository:
git clone https://github.com/Kawtharuna/frontend.git
  1. Install Dependencies:
    • Run in your terminal:
npm run install
  1. Running in Development Mode:
    • Run in your terminal:
npm run dev
  • This will start the Angular development server.
  1. View in Browser:
    • Open in your web browser: http://localhost:8080
    • You should now see the Kawtharuna frontend application running.

🔧 Running Tests

To ensure the quality and functionality of your changes, run the tests:

npm run test

🛠️ Production Setup

  1. Build for Production:
    • Execute in your terminal:
npm run build_prod
  • This will build the Angular application for production deployment.
  1. Deploy:
    • Deploy the contents of the dist/ directory to your production server.
    • This will make the application available for public access.

📝 Contributing

Contributions are greatly appreciated and help make the Kawtharuna community a fantastic place to learn, inspire, and create.

How to Contribute:

  1. Fork the Project:

    • Create a copy of the project in your own GitHub account.

  2. Create Your Feature Branch:

    git checkout -b frontend/feature/AmazingFeature

  3. Commit Your Changes:

    git commit -m 'Add some AmazingFeature'

  4. Push to the Branch:

    git push origin frontend/feature/AmazingFeature

  5. Open a Pull Request:

    • Compare your branch with the original project and create a pull request.

Contribution Guidelines:

  • Write clean, maintainable, and well-documented code.
  • Adhere to the existing coding standards of the project.
  • Include tests for new features whenever possible.
  • Update the README.md file if necessary, especially when adding new features or making changes that affect how users interact with the application.

License

This project is distributed under the GPL-2.0 License. See the LICENSE file for more information.

Contact

Kawtharuna Team - Contact Page