Skip to content
This repository has been archived by the owner on Jun 28, 2021. It is now read-only.

Update docs #567

Merged
merged 8 commits into from
Jan 12, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 0 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,15 +75,8 @@ Pull requests are the greatest contributions, so be sure they are focused in sco

6. Now [open a pull request] with a clear title and description.

## Sever-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).

If you experience an issue, check the [contributing] guidelines.

[upstream]: https://help.github.com/articles/syncing-a-fork/
[contributing]: https://guides.github.com/activities/contributing-to-open-source/
[already been reported]: https://github.com/quran/quran.com-frontend/issues
[fork this project]: https://github.com/quran/quran.com-frontend/fork
[open a pull request]: https://help.github.com/articles/using-pull-requests/
31 changes: 19 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,40 @@

# 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.

## Slack Group
Signup at https://quranslack.herokuapp.com to be added to the Slack group
## 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.

## 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.
## 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.

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).
## Backend
The API source is at https://github.com/quran/quran-api-rails

DB is private, message @mmahalwy for access.

## Backend
Current at: https://github.com/quran/quran-api-rails
DB is private, message me 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.

## Slack
Signup at https://quranslack.herokuapp.com to be added to the Slack group

## Design
We currently use InvisionApp. Again, contact me if you'd like access to it.
Expand All @@ -47,4 +51,7 @@ 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/
[staging]: https://staging.quran.com