Skip to content

muneebwanee/lafz

Repository files navigation


LAFZ

Unlock the Language of the Quran


Stars Badge Forks Badge Issues Badge License Badge

Explore the App »

Report Bug · Request Feature

📖 About The Project

LAFZ is an open-source web application designed to help users learn the core vocabulary of the Quran in an engaging, interactive, and structured manner. By focusing on high-frequency words, unique roots, and their various forms, LAFZ provides a guided journey to unlock a deeper connection with every verse.

The project is built with a modern tech stack and a clean, card-based UI to make learning both effective and enjoyable.

✨ Features

  • Interactive Learning Paths: Guided chapters for high-frequency words, unique roots, and word forms.
  • Progress Tracking: Mark words as 'learned' and track your progress through chapters and categories.
  • Review Zone: A Spaced Repetition System (SRS) to help you review words at the perfect time to maximize retention.
  • Multilingual Definitions: Access definitions and examples in English, Urdu, and Hinglish for each word.
  • Search Functionality: Instantly search for any word across the entire vocabulary.
  • Responsive Design: A beautiful and functional experience on both desktop and mobile devices.
  • Light & Dark Themes: Switch between themes for your reading comfort.
  • Open Source: Built by the community, for the community.

🛠️ Built With

LAFZ is built with a modern, type-safe, and performant technology stack:

🚀 Getting Started

To get a local copy up and running, follow these simple steps.

Prerequisites

You need to have Node.js and npm (or yarn/pnpm) installed on your machine.

Installation

  1. Clone the repo
    git clone [https://github.com/muneebwanee/lafz.git](https://github.com/muneebwanee/lafz.git)
  2. Navigate to the project directory
    cd lafz
  3. Install NPM packages
    npm install
  4. Run the development server
    npm run dev
  5. Open http://localhost:3000 with your browser to see the result.

🤝 Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Don't forget to give the project a star! Thanks again!

You can also contribute by:

  • Suggesting new features.
  • Reporting any bugs you find.
  • Helping to improve the word data, meanings, and examples.

📄 License

Distributed under the MIT License. See LICENSE for more information.

📬 Connect with me

Website Badge Twitter Badge LinkedIn Badge Instagram Badge

About

Unlock the Language of the Quran

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages