Baca - Online Quran Reader

Getting Started

Clone repo

git clone https://github.com/My-Quran-Tajwid/baca.git --recursive

If you git cloned without the --recursive flag, run this command to get the submodules:

git submodule update --init

Tip

To update the submodules next time, run this command:

git submodule update --remote

Open the cloned folder and create an .env file

cp .env.example .env

Then, you can choose either the following ways to run the app, using docker or the conventional way.

Using Docker

docker compose up

The database setup, data seeder, etc will be handled automatically by the docker container. You can open your application at http://127.0.0.1:8080/

Conventional way

Setup project:

composer install
npm install
php artisan key:generate

Fill in the Database connection information in the .env file. Easiest way to get started is using sqlite. Example:

DB_CONNECTION=sqlite
DB_DATABASE=D:\Development\baca\database\app.sqlite

Tip

Need help to setup MySQL database? Check out my article on how to setup MySQL server on a docker: https://iqfareez.com/blog/setup-docker-mysql-phpmyadmin

Migrate & Seed Database

php artisan migrate
php artisan db:seed

Run the development server

composer run dev

Open your application at http://127.0.0.1:8000

Attributions

• Quranic Universal Library - https://qul.tarteel.ai/
• King Fahd Glorious Quran Printing Complex - https://qurancomplex.gov.sa/