Merge pull request #3 from catalogueglobal/dev

Version release

Author: Landon Reed

.gitignore

@@ -11,3 +11,19 @@ config_server.yml
 configurations/*
 !configurations/default
 tmp/
+
+# Optional npm cache directory
+.npm
+
+# Optional REPL history
+.node_repl_history
+
+# Configurations
+configurations/*
+!configurations/default
+dist
+assets
+
+# Secret config files
+env.yml
+env.yml-original

.travis.yml

@@ -7,11 +7,13 @@ cache:
   yarn: true
 before_install:
   - npm i -g codecov
+  - pip install --user mkdocs
 script:
   - yarn run lint
   - yarn run cover-client
   - codecov
   - yarn run build
+  - mkdocs build
 
 # If sudo is disabled, CI runs on container based infrastructure (allows caching &c.)
 sudo: false

README.md

@@ -1,7 +1,11 @@
-# Transit Data Manager
+# datatools-ui
 
 The core application for Conveyal's transit data tools suite.
 
+## Configuration
+
+This repository serves as the front end UI for the Data Manager application. It must be run in conjunction with [datatools-server](https://github.com/conveyal/datatools-server)
+
 ## Documentation
 
-View the [latest documentation](http://conveyal-data-tools.readthedocs.org/en/latest/) at ReadTheDocs.
+View the [latest documentation](http://conveyal-data-tools.readthedocs.org/en/latest/) at ReadTheDocs for more info on deployment and development as well as a user guide.

configurations/default/env.yml.tmp

@@ -0,0 +1,7 @@
+AUTH0_CLIENT_ID: your-auth0-client-id
+AUTH0_DOMAIN: your-auth0-domain
+MAPZEN_TURN_BY_TURN_KEY: test-turn-key
+MAPBOX_ACCESS_TOKEN: test-access-token
+MAPBOX_MAP_ID: mapbox.streets
+MAPBOX_ATTRIBUTION: <a href="https://www.mapbox.com/about/maps/" target="_blank">&copy; Mapbox &copy; OpenStreetMap</a> <a href="https://www.mapbox.com/map-feedback/" target="_blank">Improve this map</a>
+# R5_URL: http://localhost:8080

configurations/default/settings.yml

@@ -3,41 +3,20 @@ entries:
   - lib/index.css:dist/index.css
 application:
   data:
-    mapdb: /path/to/mapdb
-    gtfs: /path/to/gtfs
-    editor_mapdb: /path/to/editor
-    regions: /path/to/regions/geojson
-    use_s3_storage: false
     gtfs_s3_bucket: bucket-name
-  port: 4000
   title: Data Manager
-  assets_bucket: bucket-name
   logo: http://gtfs-assets-dev.conveyal.com/data_manager.png # defaults to src/main/client/assets/application_logo.png
   active_project: project-id
   notifications_enabled: false
-  public_url: http://localhost:9000
   docs_url: http://docs.example.com
   changelog_url: https://changelog.example.com
   support_email: support@example.com
-  osm_vex: http://localhost:1000
-  r5: http://localhost:8080
   date_format: MMM Do YYYY
-
-auth0:
-  domain: your-auth0-domain
-  client_id: your-auth0-client-id
-MAPZEN_TURN_BY_TURN_KEY: API_KEY
-mapbox:
-  access_token: MAPBOX_ACCESS_TOKEN
-  map_id: conveyal.ie3o67m0
 modules:
   enterprise:
     enabled: false
   editor:
     enabled: true
-  legacy_editor:
-    enabled: false
-    url: http://localhost:9001
   alerts:
     enabled: false
     use_extension: mtc
@@ -51,16 +30,9 @@ modules:
     enabled: false
   gtfsapi:
     enabled: false
-    load_on_fetch: false
-    load_on_startup: false
     use_extension: mtc
-    update_frequency: 3600 # in seconds
-
 extensions:
   transitland:
-    enabled: true
-    api: https://transit.land/api/v1/feeds
+    enabled: false
   transitfeeds:
-    enabled: true
-    api: http://api.transitfeeds.com/v1/getFeeds
-    key: your-api-key
+    enabled: false

docs/dev/deployment.md

@@ -2,27 +2,40 @@
 
 ## Prerequisites
 
-The application features a Spark-powered Java backend and a Javascript frontend written with React and Redux. To install and deploy the application, you will need Java 8, Maven, Node/npm, yarn, and [mastarm](https://github.com/conveyal/mastarm).
+The application consists of two repositories: a [Spark-powered Java backend](https://github.com/conveyal/datatools-server) and a [Javascript frontend written with React and Redux](https://github.com/conveyal/datatools-ui). To install and deploy the application, you will need Java 8, Maven, Node/npm, yarn, and [mastarm](https://github.com/conveyal/mastarm).
 
-User athentication is done via [Auth0](http://auth0.com). You will need an Auth0 account and application to use the Data Manager.
+User authentication is done via [Auth0](http://auth0.com). You will need an Auth0 account and application to use the Data Manager.
 
 ## Installation and Basic Configuration
 
 Clone the repo and change to the project directory:
 
 ```bash
-$ git clone https://github.com/conveyal/datatools-manager.git
-$ cd datatools-manager
+$ git clone https://github.com/conveyal/datatools-ui.git
+$ git clone https://github.com/conveyal/datatools-server.git
 ```
 
-Copy the included configuration templates:
+Copy the included configuration `env` templates for both the server and UI repos:
 
 ```bash
-$ cp config.yml.template config.yml
-$ cp config_server.yml.template config_server.yml
+$ cp datatools-ui/configurations/default/env.yml.tmp datatools-ui/configurations/default/env.yml
+$ cp datatools-server/configurations/default/env.yml.tmp datatools-server/configurations/default/env.yml
 ```
 
-Create directories on your local machine to store the MapDB databases, GTFS feeds, and GeoJSON data. Update the following properties in `config.yml` to reflect these locations:
+You'll then need to supply Auth0 account information (see below) and API keys for various services used in the application.
+
+The default `server.yml` (for `datatools-server`) and `settings.yml` (for `datatools-ui`) should work out of the box, but you may want to specify alternative settings files outside of these repositories. These can be specified as a directory during `datatools-ui` build with mastarm:
+
+```bash
+$ mastarm build --config /path/to/configurations/dir
+```
+
+AND as individual file args for `datatools-server`:
+
+```bash
+$ java -jar target/dt-v1.0.0.jar /path/to/env.yml /path/to/server.yml
+```
+In `datatools-server:server.yml`, be sure to update the paths for where the databases will be stored:
 
 ```yaml
 application:
@@ -65,26 +78,24 @@ Create your first Auth0 user through Auth0 web console (Users > Create User). In
 }
 ```
 
-#### Update `config.yml` and `config_server.yml`
-Update the following properties in `config.yml` to reflect the public Auth0 application settings:
+#### Update `env.yml` for both
+Update the following properties in **both** `env.yml` files to reflect the public Auth0 application settings:
 
 ```yaml
-auth0:
-  domain: your-auth0-domain.auth.com
-  client_id: your-auth0-client-id
+AUTH0_DOMAIN: your-auth0-domain.auth.com
+AUTH0_CLIENT_ID: your-auth0-client-id
 ```
 
-Update the following properties in `config_server.yml` to reflect the secure Auth0 application settings:
+Update the following properties in `datatools-server` `env.yml` to reflect the secure Auth0 application settings:
 
 ```yaml
-auth0:
-  client_secret: your-auth0-client-secret
-  api_token: your-auth0-api-token
+AUTH0_SECRET: your-auth0-client-secret
+AUTH0_TOKEN: your-auth0-api-token
 ```
 
 **Note**: to generate the `api_token`, go to Documentation > Management API. After adding scopes, your token will appear in the input field.
 
-![Auth0 token generator](/img/auth0-token-generator.png =50x)
+![Auth0 token generator](../img/auth0-token-generator.png)
 
 To allow for the creation, deletion and editing of users you must generate a token for the following scopes:
 
@@ -117,12 +128,12 @@ $ mvn package
 Deploy the application with Java:
 
 ```bash
-$ java -jar target/datatools.jar
+$ java -jar target/dt-v1.0.0.jar /path/to/env.yml /path/to/server.yml
 ```
 
 
-The application back-end should now be running at `http://localhost:9000` (or whatever port you specified in `config.yml`).
-The front-end assets are pointed to by the back end at whatever s3 bucket name is specified in `config.yml` at `application.assets_bucket`.
+The application back-end should now be running at `http://localhost:9000` (or whatever port you specified in `server.yml`).
+The front-end assets are pointed to by the back end at whatever s3 bucket name is specified in `server.yml` at `application.assets_bucket`.
 
 ## Configuring Modules
 
@@ -135,25 +146,26 @@ Enables the GTFS Editor module.
 #### List of configuration settings
 
 - `MAPZEN_TURN_BY_TURN_KEY`
-- `mapbox`
-  - `access_token`
-  - `map_id`
+- `MAPBOX_MAP_ID`
+- `MAPBOX_ACCESS_TOKEN`
+- `R5_URL` (optional parameter for r5 routing in editor pattern drawing)
 
 ### Validator
 
 While the application handles basic validation even without the validator module enabled, the validator allows for enhanced accessibility- and map-based validation.
 
 #### List of configuration settings
 
-- `application.osm_vex` -  the validator requires the URL of a running instance of the [OSM vex server](https://github.com/conveyal/vanilla-extract).
+- `OSM_VEX` - `datatools-server:env.yml` the validator requires the URL of a running instance of the [OSM vex server](https://github.com/conveyal/vanilla-extract).
+
 
 ### Sign Configurations
 
 Enables the sign configuration module.
 
 #### List of configuration settings
 
-- `use_extension` - extension to use for sign configuration
+- `use_extension` - extension key to use for sign configuration
 - `url`
 - Requires `gtfsapi` module
 
@@ -163,7 +175,7 @@ Enables the real-time alerts module.
 
 #### List of configuration settings
 
-- `use_extension` - extension to use for sign configuration
+- `use_extension` - extension key to use for sign configuration
 - `url`
 - Requires `gtfsapi` module
 
@@ -177,7 +189,7 @@ Enables the OTP automated deployments module.
 
 #### List of configuration settings
 
-- `application.osm_vex` -  the validator requires the URL of a running instance of the [OSM vex server](https://github.com/conveyal/vanilla-extract).
+- `OSM_VEX` - `datatools-server:env.yml`  the validator requires the URL of a running instance of the [OSM vex server](https://github.com/conveyal/vanilla-extract).
 
 ### GTFS API
 
@@ -188,7 +200,7 @@ Supports other modules with API endpoints for getting GTFS entities (routes, sto
 - `load_on_fetch` - whether to load GTFS feeds when new feed is detected
 - `load_on_startup` - whether to load GTFS feeds on application startup
 - `use_extension` - which extension to connect to
-- `update_frequency` - update frequency for GTFA API (in seconds)
+- `update_frequency` - update frequency for GTFS API (in seconds). Comment out to disable updates.
 
 ## Configuring Extensions
 

docs/dev/development.md

@@ -10,4 +10,10 @@ To kick off a development server at [http://localhost:9966](http://localhost:996
 npm start
 ```
 
-This will use `mastarm` to run a browserify server at the above port along with a proxy for the back-end API, which is assumed to be running on http://localhost:4000.
+This will use `mastarm` to run a browserify server at the above port along with a proxy for the back-end API, which is assumed to be running on http://localhost:4000.
+
+To optionally substitute the default configuration, provide your own directory:
+
+```
+npm start -- --config /path/to/config
+```