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

Commit a381c62

Browse files
umairidrismmahalwy
authored andcommitted
Update docs (#567)
* Update docs * Update CONTRIBUTING.md * Update README.md * Mention staging
1 parent fa288e9 commit a381c62

File tree

2 files changed

+19
-19
lines changed

2 files changed

+19
-19
lines changed

CONTRIBUTING.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -75,15 +75,8 @@ Pull requests are the greatest contributions, so be sure they are focused in sco
7575

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

78-
## Sever-side integration
79-
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.
80-
81-
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).
82-
83-
If you experience an issue, check the [contributing] guidelines.
8478

8579
[upstream]: https://help.github.com/articles/syncing-a-fork/
86-
[contributing]: https://guides.github.com/activities/contributing-to-open-source/
8780
[already been reported]: https://github.com/quran/quran.com-frontend/issues
8881
[fork this project]: https://github.com/quran/quran.com-frontend/fork
8982
[open a pull request]: https://help.github.com/articles/using-pull-requests/

README.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,40 @@
1-
21
# Quran.com
32

4-
This is the project soon to be the Quran.com facing site. This is built in
3+
This project is the frontend for Quran.com. It is built using
54
[Reactjs] + [Redux] + [Expressjs] + [Webpack]. It is isomorphic (javascript shared
65
between both the server and the client) for SEO reasons.
76

87
[![Stories Ready](https://badge.waffle.io/quran/quran.com-frontend.svg?label=ready&title=Ready)](http://waffle.io/quran/quran.com-frontend)
98
[![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)
109
[![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)
1110

12-
1311
[![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)
1412
[![Code Climate](https://codeclimate.com/github/quran/quran.com-frontend.png)](https://codeclimate.com/github/quran/quran.com-frontend)
1513

1614
## 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.
15+
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.
1816

1917
Read the [contributing] section before creating an issue.
2018

21-
## Slack Group
22-
Signup at https://quranslack.herokuapp.com to be added to the Slack group
19+
## Running the app locally
20+
- Ensure you have [nodejs] installed
21+
- Get the source by running `git clone https://github.com/quran/quran.com-frontend/` or creating a [fork]
22+
- Run `npm install` to do first time installation of all dependencies
23+
- Run `npm run dev` to start the dev server
24+
- Open `http://localhost:8000` in your browser to see the app.
2325

24-
## Server-Side Integration
25-
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.
26+
## Staging
27+
To see the app with the latest changes, see the [staging] site. Production releases are made periodically when staging is stable and well tested.
2628

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

32+
DB is private, message @mmahalwy for access.
2933

30-
## Backend
31-
Current at: https://github.com/quran/quran-api-rails
32-
DB is private, message me for access.
34+
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.
3335

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

3539
## Design
3640
We currently use InvisionApp. Again, contact me if you'd like access to it.
@@ -47,4 +51,7 @@ analyze-bundle-size bundle-stats.json
4751
[Redux]: http://redux.js.org/
4852
[Expressjs]: http://expressjs.com/en/starter/hello-world.html
4953
[Webpack]: http://webpack.github.io/docs/what-is-webpack.html
54+
[nodejs]: https://nodejs.org/en/
5055
[contributing]: CONTRIBUTING.md
56+
[fork]: https://help.github.com/articles/fork-a-repo/
57+
[staging]: https://staging.quran.com

0 commit comments

Comments
 (0)