reshadn / tarteel-frontend

The frontend for Tarteel.io

Tarteel

Tarteel is an open-source project designed to help build digital tools to analyze the recitation of the Quran. Given the important place of reciting the Quran in the lives of Muslims, it is important to build software tools that can help ordinary Muslims recite the Quran with greater accuracy and appreciation. The name tarteel comes from the Quran itself, where God commands us to "recite the Quran with tarteel (slow, measured rhythmic tones)" (73:4).

👋 Intro

This repo is the frontend for Tarteel.io, a server-side rendered Progressive Web App built using React, Redux, Express, Webpack, and styled-components. The architecture is inspired by Quran.com's frontend repo

✨ Features

• Recitation Collection
• Ayah Evaluation
• Dataset Download
• Ayah Recognition
• Recitation Correction (soon!)

🎯 Target

We set targets for Ayahs recitation numbers, Our last target was collecting 100,000 recitations. Now we're trying to get those evaluated (view progress).

🔧 Getting started

To start developing, you'll first need to get the Tarteel api server running locally. We require this to avoid submitting testing ayahs to production (and for us to experiment with backend changes).

Installation

git clone https://github.com/Tarteel-io/tarteel-frontend.git tarteel-frontend
cd tarteel-frontend
yarn
yarn dev

Build

yarn build
yarn build:dev

Linters & Formatting

yarn lint
yarn format:src
yarn format:config
yarn format:internal

Format only staged files

yarn precommit

🔨 Contributing

If you want to start contributing to any of the Tarteel projects, please contact us. In the meantime, feel free to pick up any of the open issues and assign it to yourself or create a PR for any bugs you encounter.

To create a PR, branch off master and include your name and the feature name following this pattern: yourname/feature_name

💸 Donate

You can contribute to our server costs, marketing and other expenses. If you're interested in donating, please contact us!

😇 Sharing Tarteel

You'll be contributing to our mission in many ways by sharing tarteel: getting more recordings, PR, and potentially getting donations + volunteers. Feel free to share it on your personal timeline or in different groups / email lists.

🛣 License

MIT

Notes

• We have a problem with Now.sh in the assets that are contains capital letters so for now please rename any asset file to be in lowercase