This repository has been archived by the owner on Jun 28, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 361
Update docs #567
Merged
Merged
Update docs #567
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
76f5955
Update docs
umairidris 4ec0b66
Update CONTRIBUTING.md
umairidris cc1ee84
Merge branch 'master' into docupdates
thabti 09ef22b
Merge branch 'master' into docupdates
mmahalwy b02970b
Merge upstream
umairidris 91ffb27
Merge branch 'docupdates' of https://github.com/umairidris/quran.com-…
umairidris e4149ab
Update README.md
umairidris 3011f4b
Mention staging
umairidris File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1,34 @@ | ||
|
||
# Quran.com | ||
|
||
This is the project soon to be the Quran.com facing site. This is built in | ||
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. | ||
|
||
[![Stories Ready](https://badge.waffle.io/quran/quran.com-frontend.svg?label=ready&title=Ready)](http://waffle.io/quran/quran.com-frontend) | ||
[![Stories In Progress](https://badge.waffle.io/quran/quran.com-frontend.svg?label=in%20progress&title=In%20Progress)](http://waffle.io/quran/quran.com-frontend) | ||
[![Stories In Review](https://badge.waffle.io/quran/quran.com-frontend.svg?label=in%20review&title=In%20Review)](http://waffle.io/quran/quran.com-frontend) | ||
|
||
|
||
[![Dependency Status](https://david-dm.org/quran/quran.com-frontend.svg)](https://david-dm.org/quran/quran.com-frontend) [![devDependency Status](https://david-dm.org/quran/quran.com-frontend/dev-status.svg)](https://david-dm.org/quran/quran.com-frontend#info=devDependencies) | ||
[![Code Climate](https://codeclimate.com/github/quran/quran.com-frontend.png)](https://codeclimate.com/github/quran/quran.com-frontend) | ||
|
||
## 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. | ||
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. | ||
|
||
## Server-Side Integration | ||
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. | ||
|
||
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). | ||
|
||
## 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. | ||
|
||
## Backend | ||
Current at: https://github.com/quran/quran-api-rails | ||
The API source is at https://github.com/quran/quran-api-rails | ||
|
||
DB is private, message me for access. | ||
|
||
The dev server uses the production 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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. uses staging api |
||
|
||
## Design | ||
We currently use InvisionApp. Again, contact me if you'd like access to it. | ||
|
@@ -44,4 +45,6 @@ analyze-bundle-size bundle-stats.json | |
[Redux]: http://redux.js.org/ | ||
[Expressjs]: http://expressjs.com/en/starter/hello-world.html | ||
[Webpack]: http://webpack.github.io/docs/what-is-webpack.html | ||
[nodejs]: https://nodejs.org/en/ | ||
[contributing]: CONTRIBUTING.md | ||
[fork]: https://help.github.com/articles/fork-a-repo/ |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
me is me :)