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
+20-5Lines changed: 20 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -78,6 +78,16 @@ is used, see the documentation [here](Documents/cluster.md)
78
78
79
79
### Interactive
80
80
81
+
#### Running the Dependencies
82
+
83
+
Assuming you have Docker-Compose installed, the easiest way to get all of the platform's dependencies up and running with the provided docker-compose dev setup:
84
+
85
+
`docker-compose -f docker-dev.yml up`
86
+
87
+
Alternatively, you can start each one individually with the following instructions.
88
+
89
+
##### Write Journal
90
+
81
91
* The write side of this system is supported by either a local `leveldb` database or Cassandra. By default, the local `leveldb` is utilized, and some sample data is loaded automatically.
82
92
If using `Cassandra` is desired, the following environment variable needs to be set:
83
93
@@ -112,6 +122,7 @@ run <full local path to sample file>
112
122
```
113
123
A sample file is located in the following folder: `panel/src/main/resources/inst_data_2017_dummy.csv`
114
124
125
+
##### Read Journal
115
126
116
127
* In order to support the read side, a local PostgreSQL and Cassandra server are needed. Assuming it runs on the default port, on the same machine as the API, the following environment variable needs to be set:
where `hmda` is the name of the `PostgreSQL` database, owned by the default user with default password (`postgres`)
123
134
135
+
**Note: if you are running the backend only through sbt, the database needs to be created manually in advance, see instructions [here](https://www.postgresql.org/docs/9.1/static/manage-ag-createdb.html)**
136
+
124
137
For Cassandra, the following environment variables need to be set (assuming Cassandra is running on a docker container as described above):
125
138
126
139
```shell
127
140
export CASSANDRA_CLUSTER_HOSTS=192.168.99.100
128
141
export CASSANDRA_CLUSTER_PORT=9042
129
142
```
130
143
131
-
**Note: if you are running the backend only through sbt, the database needs to be created manually in advance, see instructions [here](https://www.postgresql.org/docs/9.1/static/manage-ag-createdb.html)**
144
+
##### Apache Zookeeper
132
145
133
146
* The `HMDA Platform` is a distributed system that is meant to be run as a clustered application in production.
134
147
As such, it needs a mechanism for storing configuration information for additional nodes joining the cluster.
@@ -139,18 +152,17 @@ An easy way to satisfy this requirement is to launch a docker container with `Zo
Alternatively, these dependencies (`Cassandra`, `Zookeeper` and `PostgreSQL`) can be started from `docker` providing default resources for the `HMDA Platform`:
150
162
151
-
`docker-compose -f docker-dev.yml up`
163
+
#### Running the API
152
164
153
-
* If you want to use the sample files in this repo for testing the app, run the edits in demo mode. Otherwise, edit S025 will trigger for all files.
165
+
* If you want to use the sample files in this repo for testing the app, run the edits in demo mode by adding the following environment variable. Otherwise, edit S025 will trigger for all files.
154
166
155
167
```shell
156
168
export EDITS_DEMO_MODE=true
@@ -173,6 +185,9 @@ $ sbt
173
185
174
186
Confirm that the platform is up and running by browsing to http://localhost:8080
175
187
188
+
189
+
#### Building the Project
190
+
176
191
* To build JVM artifacts (the default, includes all projects), from the sbt prompt:
0 commit comments