![A screenshot of the Qur'an Study Tool, with an explanation up on the right of the screen](https://m1s5.c20.e2-5.dev/files/images/quran-study-tool-preview-optimized.png)

# Quick Explanation

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 `git` repository up for y'all who like to build your docker containers by hand

---

# 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](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) (or [oxc](https://oxc.rs) when used in [rolldown-vite](https://vite.dev/guide/rolldown)) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) 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](https://react.dev/learn/react-compiler/installation).

## 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](https://github.com/vitejs/vite/tree/main/packages/create-vite/template-react-ts) for information on how to integrate TypeScript and [`typescript-eslint`](https://typescript-eslint.io) in your project.