|
1 | | -[](http://waffle.io/quran/quran.com-frontend) |
2 | | -[](http://waffle.io/quran/quran.com-frontend) |
3 | | -[](http://waffle.io/quran/quran.com-frontend) |
4 | 1 |
|
| 2 | +# Quran.com |
5 | 3 |
|
6 | | -## Quran.com |
7 | 4 | This is the project soon to be the Quran.com facing site. This is built in |
8 | | -Reactjs + Redux + Expressjs + Webpack. It is isomorphic (javascript shared |
| 5 | +[Reactjs] + [Redux] + [Expressjs] + [Webpack]. It is isomorphic (javascript shared |
9 | 6 | between both the server and the client) for SEO reasons. |
10 | 7 |
|
11 | | -[](https://david-dm.org/quran/quran.com-frontend) |
| 8 | +[](http://waffle.io/quran/quran.com-frontend) |
| 9 | +[](http://waffle.io/quran/quran.com-frontend) |
| 10 | +[](http://waffle.io/quran/quran.com-frontend) |
| 11 | + |
| 12 | + |
| 13 | +[](https://david-dm.org/quran/quran.com-frontend) [](https://david-dm.org/quran/quran.com-frontend#info=devDependencies) |
12 | 14 | [](https://codeclimate.com/github/quran/quran.com-frontend) |
13 | 15 |
|
14 | | -#### Getting started |
15 | | -Simply clone this repo, then run `npm install` to install all the required node_modules. |
16 | | -From there, you are ready to go! |
| 16 | +## How to contribute |
| 17 | +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. |
17 | 18 |
|
18 | | -#### Developing |
19 | | -To start the app, run `npm run dev` which will |
20 | | -run both the server and the client (webpack) to compile upon edits. Go to localhost:8001 in your browser, not 8000 (that is just the express server). |
| 19 | +Read the [contributing] section before creating an issue. |
21 | 20 |
|
22 | | -#### Tests |
23 | | -Run `npm run test:watch` to run the tests locally and watching. Otherwise use `npm run test` for CI level tests. |
| 21 | +## Server-Side Integration |
| 22 | +Unless you have the backend API running locally, you will need to update the `API_URL`, in `development.env` file, from `localhost` to `api.quran.com`. Leave the port number same. |
| 23 | + |
| 24 | +To start the app, run `npm run dev` which will run both the server and the client (webpack) to compile upon edits. Go to http://localhost:8001 in your browser, not 8000 (that is just the express server). |
24 | 25 |
|
25 | | -We also have nightwatch function tests. You can install nightwatch globally and can run tests like this: |
26 | | -``` |
27 | | -nightwatch --test tests/functional/specs/Index_spec.js |
28 | | -``` |
29 | 26 |
|
30 | | -#### Backend |
| 27 | +## Backend |
31 | 28 | Current at: https://github.com/quran/quran-api-rails |
32 | 29 | DB is private, message me for acceess. |
33 | 30 |
|
34 | | -#### How to contribute |
35 | | -Fork this repo, then create a PR for specific fixes, improvements, etc. We trust that |
36 | | -you will not steal this, this is at the end of the day for the sake of Allah and we |
37 | | -all have good intentions while working with this project. But I must stress, stealing |
38 | | -this is unacceptable. |
39 | 31 |
|
40 | | -#### Design |
| 32 | +## Design |
41 | 33 | We currently use InvisionApp. Again, contact me if you'd like access to it. |
42 | 34 |
|
43 | | -#### Making sure main.js is small |
| 35 | +## Making sure main.js is small |
44 | 36 | Follow: https://www.npmjs.com/package/webpack-bundle-size-analyzer |
45 | 37 | ``` |
46 | 38 | env NODE_ENV=development webpack --json > bundle-stats.json |
47 | 39 | subl bundle-stats.json #so that you can the output |
48 | 40 | analyze-bundle-size bundle-stats.json |
49 | 41 | ``` |
50 | 42 |
|
51 | | -###### [View project issues on waffle.io...](https://badge.waffle.io/quran/quran.com-frontend) |
| 43 | +## [View project issues on waffle.io...](https://waffle.io/quran/quran.com-frontend) |
| 44 | + |
| 45 | +[Reactjs]: https://facebook.github.io/react/docs/getting-started.html |
| 46 | +[Redux]: http://redux.js.org/ |
| 47 | +[Expressjs]: http://expressjs.com/en/starter/hello-world.html |
| 48 | +[Webpack]: http://webpack.github.io/docs/what-is-webpack.html |
| 49 | +[contributing]: CONTRIBUTING.md |
0 commit comments