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
Copy file name to clipboardExpand all lines: README.md
+14-2Lines changed: 14 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,6 +35,7 @@ The configuration is overridable by environment variables, expressed between []:
35
35
-`api` - The address for the API. [API]
36
36
-`iDEditor` - The address of the iDEditor. Defaults to the `master` branch of the [RAM fork of iD](https://github.com/WorldBank-Transport/ram-id), hosted on GH Pages. (Default: https://id.ruralaccess.info). [IDEDITOR]
37
37
-`mbtoken` - The Mapbox Token to load map tiles from. [MBTOKEN]
38
+
-`rahUrl` - The url for the Rural Accessibility Hub. [RAH_URL]
38
39
-`auth` - The configuration for optional authentication with Auth0. By default, no authentication is set (Default: {})
39
40
-`auth.domain` - See instructions below [AUTH_DOMAIN]
40
41
-`auth.clientID` - See instructions below [AUTH_CLIENTID]
@@ -47,6 +48,7 @@ module.exports = {
47
48
api: 'http://localhost:4000',
48
49
idEditor: 'https://id.ruralaccess.info',
49
50
mbtoken: 'asfd23rlmksjdf023rnnsafd',
51
+
rahUrl: 'http://rah.surge.sh'
50
52
auth: {}
51
53
};
52
54
```
@@ -72,7 +74,7 @@ Compiles the sass files, javascript, and launches the server making the site ava
72
74
The system will watch files and execute tasks whenever one of them changes.
73
75
The site will automatically refresh since it is bundled with livereload.
74
76
75
-
# Deployment
77
+
##Deployment
76
78
To prepare the app for deployment run:
77
79
78
80
```
@@ -81,7 +83,7 @@ yarn build
81
83
This will package the app and place all the contents in the `dist` directory.
82
84
The app can then be run by any web server.
83
85
84
-
## Docker
86
+
###Docker
85
87
The RAM frontend is also available in a [Docker container](https://hub.docker.com/r/wbtransport/ram-frontend/). This container builds the site and serves the interface through nginx. [Environment variables](#config-files) will be picked up when the container is run:
86
88
87
89
```yml
@@ -96,3 +98,13 @@ services:
96
98
```
97
99
98
100
To run the full RAM stack in Docker, you can use the `docker-compose.yml` file that's available in the [RAM backend repo](https://github.com/WorldBank-Transport/ram-backend/blob/develop/docker-compose.yml).
101
+
102
+
### Releasing a new version
103
+
The process to release a new version:
104
+
105
+
- still on `develop`, bump the version in `package.json`
106
+
- set up PR, have somebody do a review and merge `develop` into `master`
107
+
- CircleCI will add a new tag to git using the version in `package.json`
108
+
- if the tagging was successful, CircleCI will build the Docker image, tag it with the version number and push it to Docker Hub. If the tagging failed (because the version wasn't updated in `package.json`), the build fails
109
+
110
+
Once this is done, you can [add a new release on Github](https://github.com/WorldBank-Transport/ram-frontend/releases/new) with useful notes that describe it.
0 commit comments