/swadeeq

Swadeeq is a chat bot, developed to help muslims to be consistent on deen.

Primary LanguageTypeScriptMIT LicenseMIT

Contributors Forks Stargazers Issues MIT License Download LinkedIn


Logo

Swadeeq - An AI chat friend to muslims

Swadeeq is a chat bot, developed to help muslims to be consistent on deen.
Install app from here »

Screenshots · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Contributing
  4. License
  5. Contact
  6. Acknowledgments

Screenshots

About The Project

Swadeeq is a mobile app designed to help Muslims stay consistent in their faith and strengthen their spiritual connection with Allah. With its chatbot interface, users can easily ask the bot about prayer times for their location, Islamic rulings on various topics, and get inspired to pray on time. The app also includes styled replies from the chatbot, rich dark-themed UI, Islamic calendar response, automatic notifications on prayer, dhikr, sleep and wakeup times, replying with hadiths and surah ayahs, or surah info, and basic knowledge about Islam and tawheed.

Built with Ionic and Capacitor, Swadeeq provides a seamless user experience with fast load times and smooth navigation. Its beautiful DaisyUI Dark theme enhances the user experience while also making it easier to prioritize faith throughout the day. Whether you're a devout Muslim or just starting to learn about Islam, Swadeeq has something for everyone.

Features:-

  • Get prayer times by location in chatbot
  • Basic greetings for bot
  • Basic conversation trained
  • Ask bot about Islamic rulings on various topics
  • Get inspired to pray on time
  • Styled reply from chatbot
  • Rich dark themed UI
  • Islamic calendar response
  • Notifications on prayer, dhikr, sleep and wakeup times
  • Replying with hadiths and surah ayahs, or surah info
  • Basic knowledge about Islam and Tawheed

(back to top)

❗ Informations used

I have tried to only include valid data to the app, I am also a human being: any information that is not valid can be reported on https://github.com/Muhammed-Rahif/swadeeq/issues, and highly encourage that to report as soon as possible with clear evidences.

(back to top)

Built With

Major frameworks/libraries used to bootstrap the project.

  • React
  • Nlp.js
  • Ionic
  • Capacitor
  • Tailwind CSS
  • DaisyUi

(back to top)

Getting Started

  1. First, ensure you have Yarn installed on your machine.
  2. Install the @ionic/cli and @capacitor/cli globally by running yarn global add @ionic/cli @capacitor/cli in your terminal or command prompt.
  3. Clone this repository to your local machine using git clone https://github.com/Muhammed-Rahif/swadeeq.git.
  4. Navigate to the project directory using your terminal or command prompt.
  5. Run yarn install to install all necessary dependencies.
  6. To launch the app on your local machine, run ionic serve.
  7. Once the app is running, you can access it by navigating to http://localhost:8100 in your web browser.

And that's it! You should now have a local copy of Swadeeq running on your machine. If you encounter any issues, please refer to the project's documentation or reach out to our support team for assistance.

Useful commands

# build command for dubug
ionic capacitor copy android && cd android && gradlew assembleDebug && cd ..

# build command for release
ionic capacitor copy android && cd android && gradlew assembleRelease && cd ..

# install to external device directly dubug version
ionic capacitor copy android && cd android && gradlew assembleDebug && gradlew installDebug && cd ..

# android external device run
ionic capacitor run android -l --watch --external

Contributing

With 'swadeeq' app, I believe that contributing to an app that benefits the Ummah is a way to earn rewards from Allah SWT. That's why I've created an app that helps Muslims on their journey towards spiritual growth and consistency in practicing their faith. By building and contributing to 'swadeeq', you have the opportunity to earn rewards from Allah SWT and be a part of a community-driven effort to empower Muslims to achieve their spiritual goals. Whether you're a developer, a designer, or just someone with an idea, your contribution can help make a difference. So, join us in this journey and contribute for the sake of Allah. Together, we can create valuable tools that benefit the Ummah and earn rewards in this life and the hereafter.

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

(back to top)

License

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

(back to top)

Contact

Muhammed Rahif - @Muhammed_Rahif - rahifpalliyalil@gmail.com

Project Link: https://github.com/Muhammed-Rahif/swadeeq

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

(back to top)