Muraja'ah

A Quran memorization app that uses scientific spaced repetition techniques to optimize your memory and make memorization more efficient.

Table of Contents

• Setup
  • Prerequisites
    • Chocolatey Installation
    • Homebrew Installation
    • APT Installation
  • Installation
    • DevPod (recommended)
    • Manual
• Running
• Features
• Troubleshooting

Setup

This project uses devcontainers to streamline the setup process. Moreover, this project is DevPod compatible, so it may be used to make the build process even easier.

Prerequisites

• Docker Desktop or an alternative Docker option, like Docker on a remote host or Docker compliant CLI, installed
  • Docker must be running!
• Visual Studio Code (VSCode) installed
  • Dev Containers plugin
• Expo Go installed on mobile device
• DevPod (optional) installed

Chocolatey Installation

If using Windows, it's recommended to install the pre-requisites using chocolatey. If you have some of the applications already installed, consider removing them in favor of the chocolatey installation or modify the command to not install it if you prefer.

choco install docker-desktop docker-compose vscode devpod

Note: For Docker Desktop to work on Windows, WSL must be installed. You will see this be an error if you start Docker Desktop after installing.

Homebrew Installation

If using MacOS, it's recommended to install the pre-requisites using homebrew. If you have some of the applications already installed, consider removing them in favor of the homebrew installation or modify the command to not install it if you prefer.

brew install --cask docker visual-studio-code
brew install devpod

APT Installation

If using an Ubuntu-based operating system, it's recommended to install the pre-requisites using apt-get and snap.

sudo apt update && sudo apt install -y docker.io docker-compose devpod
sudo snap install --classic code

Installation

DevPod (recommended)

1. Open DevPod application.
2. Click + Create workspace.
   • Select Docker as provider, VSCode as default IDE.
3. Enter workspace source as https://github.com/yourusername/murajaah (replace with actual repository URL)
4. Set Workspace Name (optional)
5. Click Create Workspace.

This will initialize a Dev Container instance and open an instance of VSCode within the container.

Manual

1. Clone this repository.
2. Open the code in VSCode.
3. Open the Command Palette (View -> Command Palette...).
4. Type Dev Containers: Rebuild and Reopen in Container. Select the option.

This will initialize a Dev Container instance and open an instance of VSCode within the container.

Running

Wait for post-container-creation tasks to complete. Then, use npm start to run. This will run an Expo instance, using a tunnel to go around the myriad of issues that can happen due to proxies.

Once the application is finished running, a QR Code will be generated in the output. Scan the QR code with Expo Go (Android) or the Camera app (iOS) to launch the application.

Note: The initial bundle may be slow after scanning the QR code, perhaps due to internet speeds or the tunnel.

Features

Muraja'ah helps you memorize and retain the Quran using scientific spaced repetition techniques:

• Learn and review ayahs at the optimal time
• Track your progress with detailed statistics
• Memorize at your own pace with customizable settings
• Choose between Uthmani and IndoPak scripts
• Works completely offline once set up

Troubleshooting

Issue: The DevPod container won't connect to VSCode. It says "spawn ENAMETOOLONG"

Possible Solution:

1. Go on a VSCode instance that isn't in a container.
2. Go to Remote Explorer, make sure it is in Dev Containers mode.
   • If there is nothing shown, and it says to install docker:
     1. Do systemctl restart docker in the terminal (if not systemd based or just not Linux-based in general, reload the docker service somehow).
     2. Reload VSCode.
     3. The DevPod instance will then show.
3. Right click the container, click Remove Container
4. Attempt to open the container again in DevPod.

This then starts the DevPod instance successfully again.

Issue: Expo tunnel is not working or QR code doesn't connect

Possible Solution:

1. Make sure your mobile device and development machine are connected to the internet
2. Try restarting the Expo server with npm start -- --clear
3. Check if there are any firewall or network restrictions blocking the connection