You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jun 28, 2021. It is now read-only.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
-7Lines changed: 0 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -75,15 +75,8 @@ Pull requests are the greatest contributions, so be sure they are focused in sco
75
75
76
76
6. Now [open a pull request] with a clear title and description.
77
77
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.
[](http://waffle.io/quran/quran.com-frontend)
10
9
[](http://waffle.io/quran/quran.com-frontend)
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.
18
16
19
17
Read the [contributing] section before creating an issue.
20
18
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.
23
25
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.
26
28
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
28
31
32
+
DB is private, message @mmahalwy for access.
29
33
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.
33
35
36
+
## Slack
37
+
Signup at https://quranslack.herokuapp.com to be added to the Slack group
34
38
35
39
## Design
36
40
We currently use InvisionApp. Again, contact me if you'd like access to it.
0 commit comments