Welcome to the "UstazGPT" repository! This AI Chat app is designed to provide a platform to ask questions and learn about Islamic beliefs, practices and culture. It uses OpenAI to provide users with an interactive conversation experience.
The app includes a variety of topics, from basic Islamic teachings to more complex topics.
Contributor are highly welcomed! Sponsors as well to keep the site and OpenAI API running.
Disclaimer: UstazGPT is an AI chat that is for informational purposes only and may not be 100% accurate. The information provided may not be complete or up-to-date and should not be relied upon as professional advice. UstazGPT and its affiliates cannot guarantee accuracy and shall not be held responsible for errors or inaccuracies. Please seek professional advice before making any decisions.
Clone the Repositories
git clone https://github.com/paanjoe/ustazgpt.git
Install the Node Modules
npm i
Setup the .env files
OPENAI_API_KEY=PUT_YOUR_OPENAI_API_KEY_HERE
GOOGLE_ID=GOOGLE_ID_HERE
GOOGLE_SECRET=GOOGLE_SECRET_API_KEY_HERE
NEXTAUTH_URL=YOUR_URL_HERE
API_URL=POCKETBASE_URL
GOOGLE_ANALYTICS=STREAM_ID
Start the development environment
npm run dev
Since the cost of running pre-trained embedded data & fine-tuning are quite expensive, the current source only uses prompt-based to answer questions.
Long-term vision is to train the OpenAI with the data from Quran & Hadith to give accurate and definite answer to our user.
Please go to HERE to see the dataset from Quran & Hadith.
If you want to contribute to this project feel free to open an issue here. Then you may pull request.
- Create a new branch and name the branch with a descriptive name.
- Perform some development and testing on your local.
- Once you're done, run this command
git fetch && git merge origin/mainand push the change to this repositories. - Create new pull request and fill up informative description.
- Developers will review and approve the change.
Contributors names and contact info
ex. @PaanJoe ex. @ShinjiChew
This project is licensed under the MIT License - see the LICENSE.md file for details
Inspiration, code snippets, etc.