How to contribute
We trust that you will not copy this idea/project, this is at the end for the sake of Allah and we all have good intentions while working with this project. But we must stress that copying the code/project is unacceptable.
Read the contributing section before creating an issue.
Running the app locally
- Ensure you have nodejs installed
- Get the source by running
git clone https://github.com/quran/quran.com-frontend/or creating a fork
npm installto do first time installation of all dependencies
npm run devto start the dev server. Make sure you have pm2 installed globally!
npm install -g pm2
http://localhost:8000in your browser to see the app.
To see the app with the latest changes, see the staging site. Production releases are made periodically when staging is stable and well tested.
The API source is at https://github.com/quran/quran-api-rails
DB is private, message @mmahalwy for access.
The dev server uses the staging API by default. If you want to use a local API server, follow the instructions in the API repo and run the server locally then update the API_URL field in app.json to point to the local address.
Create an issue with your email for us to add you to the Slack group
We currently use InvisionApp. Again, contact me if you'd like access to it.
Making sure main.js is small
env NODE_ENV=development webpack --json > bundle-stats.json subl bundle-stats.json #so that you can the output analyze-bundle-size bundle-stats.json