|
1 | | -# Contents of This Repo |
| 1 | +# Dev Standards |
2 | 2 |
|
3 | | -## Branch Strategy |
| 3 | +### Branch Strategy |
4 | 4 |
|
5 | 5 | * **main**: day to day work goes here. |
6 | 6 | * **dev**: current code of the dev environment. No commits allowed directly; you'll need to open a PR from main. Committing/pushing here causes a deployment to the dev infrastructure. |
7 | 7 |
|
8 | | -## Frontend Tier |
| 8 | +### GH Actions |
| 9 | + |
| 10 | +See GitHub's actions tab in this repo for more deployment examples/steps. |
| 11 | + |
| 12 | +# System Overview |
| 13 | + |
| 14 | +### Frontend Tier |
9 | 15 | * ```frontend```: The Workspaces frontend (VueJS app). |
10 | 16 | * Code here: https://github.com/TaskarCenterAtUW/workspaces-frontend. |
11 | 17 | * Uses the other components within this repo, e.g. ```osm-rails```, ```osm-cgimap``` and ```tasking-manager``` as an API backend. |
|
15 | 21 | * Workspaces version in the ```workspaces``` branch. Need to pull from public version periodically to keep up to date. |
16 | 22 | * Public version: tries to be a match to ```main``` of upstream. |
17 | 23 |
|
18 | | -## Backend Tier |
| 24 | +### Backend Tier |
19 | 25 | * ```osm-web```: Reverse proxy that dispatches requests to osm-cgimap or osm-rails depending on performance requirements. |
20 | 26 | * ```osm-log-proxy```: sits in front of the below two services, logs requests for debugging purposes. |
21 | 27 | * ```osm-rails```: “reference implementation” for OSM API for editing. Slow. |
22 | 28 | * ```osm-cgimap```: Faster version of osm-rails. API format the same as osm-rails. Only some functions of osm-rails. |
23 | 29 | * ```tasking-manager```: Not currently using, but task manager for OSM. |
24 | | - |
25 | | -# To build images |
| 30 | + |
| 31 | +# Getting Started |
| 32 | + |
| 33 | +### To build images |
26 | 34 |
|
27 | 35 | ```git clone --recursive https://github.com/TaskarCenterAtUW/workspaces-stack.git``` |
28 | 36 |
|
|
32 | 40 |
|
33 | 41 | Replace XXX.env with the environment definition file of the environment for which you want to build an image. This can be overridden when running (see below). |
34 | 42 |
|
35 | | -# To update docker daemon to run with latest images |
| 43 | +### To update docker daemon to run with latest images |
36 | 44 |
|
37 | 45 | ```docker-compose -f docker-compose.deploy.yml --env-file XXX.env up -d -pull always --force-recreate --remove-orphans``` |
38 | 46 |
|
39 | 47 | Replace XXX.env with the environment definition file of the environment for which you are deploying. |
40 | 48 |
|
41 | | -# Other Files |
| 49 | +### Other Files |
42 | 50 |
|
43 | 51 | * ```example.env```: template of the .env file required by the Docker compose YAML files |
44 | 52 | * ```tdei_uw.env```: .env for deployment at UW's TDEI center. Only UW should use this, new users should adapt example.env to suit their needs. LTG: remove this file from this repo. |
45 | 53 |
|
46 | | -# GH Actions |
47 | | - |
48 | | -See GitHub's actions tab in this repo for more deployment examples/steps. |
|
0 commit comments