A dockerized tool for studying the Qur'án in its original Arabic, with the help of Google Gemini. Build the container yourself, pull it from Docker Hub, or just run the npm vite project right from the source!
mitch donaberger
8978763630
Update 'README.md'
|
1 bulan lalu | |
|---|---|---|
| public | 1 bulan lalu | |
| src | 1 bulan lalu | |
| Dockerfile | 1 bulan lalu | |
| README.md | 1 bulan lalu | |
| docker-compose.yml | 1 bulan lalu | |
| eslint.config.js | 1 bulan lalu | |
| index.html | 1 bulan lalu | |
| package-lock.json | 1 bulan lalu | |
| package.json | 1 bulan lalu | |
| postcss.config.js | 1 bulan lalu | |
| vite.config.js | 1 bulan lalu |
README.md
An LLM-Powered Qur'án Study Tool
This is a tool meant to help people study the Qur'án in the original Arabic. It uses Google Gemini to produce translations, word breakdowns, context, or tafsir for the selected 'ayat.
Opens up on port 3000.
Quick Start 🚀
docker run -d -p 3000:3000 --name quran-study-tool unmolded1457/quran-app
or,
docker-compose build && docker run -d -p 3000:3000 --name quran-study-tool unmolded1457/quran-app
TBD
- Put the
gitrepository up for y'all who like to build your docker containers by hand - Add a means of passing API credentials through environment variables
- Add Ollama as a provider (CORS can be tricky, fair warning)
- Add DeepSeek as a provider
- Set script up to pull local versions of the Qur'án text, and to cache answers in an accessible drawer
React + Vite
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
Currently, two official plugins are available:
- @vitejs/plugin-react uses Babel (or oxc when used in rolldown-vite) for Fast Refresh
- @vitejs/plugin-react-swc uses SWC for Fast Refresh
React Compiler
The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see this documentation.
Expanding the ESLint configuration
If you are developing a production application, we recommend using TypeScript with type-aware lint rules enabled. Check out the TS template for information on how to integrate TypeScript and typescript-eslint in your project.