quran.com frontend
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Quran frontend v2 (#1005) Aug 30, 2018
.github Quran frontend v2 (#1005) Aug 30, 2018
.storybook Remove more SCSS and adding storybook for better component developing ( Nov 11, 2017
config Added italian language Nov 25, 2018
docker Many changes to get webpack for server and client (#969) Apr 28, 2018
docs Quran frontend v2 (#1005) Aug 30, 2018
internal try babel-plugin Sep 9, 2018
shared Quran frontend v2 (#1005) Aug 30, 2018
src Ensure camelcaseKeys is never passed a non-object (#1049) Nov 30, 2018
static Many changes to get webpack for server and client (#969) Apr 28, 2018
tests Remove unneeded test files (#1022) Aug 30, 2018
.babelrc Many changes to get webpack for server and client (#969) Apr 28, 2018
.editorconfig Ramadan Todo list (#343) Jun 25, 2016
.env added qurancdn and quranicaudio to scp media-src Jul 17, 2018
.eslintrc.js Quran frontend v2 (#1005) Aug 30, 2018
.gitignore Quran frontend v2 (#1005) Aug 30, 2018
.npmrc make sure new npm isntallations will not use ranges Aug 27, 2016
.nvmrc Bump node to 8.9 and remove yarn (#910) Dec 17, 2017
.prettierrc.js Quran frontend v2 (#1005) Aug 30, 2018
.stylelintrc.js Quran frontend v2 (#1005) Aug 30, 2018
Dockerfile Bump node to 8.9 and remove yarn (#910) Dec 17, 2017
LICENSE.md Change license to reflect other projects (#805) May 30, 2017
README.md Quran frontend v2 (#1005) Aug 30, 2018
jest.config.js Quran frontend v2 (#1005) Aug 30, 2018
package-lock.json most recent styled-components Sep 9, 2018
package.json most recent styled-components Sep 9, 2018
setupJest.js Quran frontend v2 (#1005) Aug 30, 2018
tsconfig.json Quran frontend v2 (#1005) Aug 30, 2018

README.md

Quran.com CircleCI

This project is the frontend for Quran.com. It is built using Reactjs + Redux + Expressjs + Webpack. It is isomorphic (javascript shared between both the server and the client) for SEO reasons.

Code Climate

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
  • Run npm install to do first time installation of all dependencies
  • Run npm run dev to start the dev server.
  • Open http://localhost:8000 in your browser to see the app.

Staging

To see the app with the latest changes, see the staging site. Production releases are made periodically when staging is stable and well tested.

Backend

The API source is at https://github.com/quran/quran.com-api

DB is private. Message on Slack to requrest 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.

Slack

Create an issue with your email for us to add you to the Slack group

Design

We currently use InvisionApp. Again, contact me if you'd like access to it.