Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rewrote ui READMEs to reflect current layout #106

Merged
merged 8 commits into from
Jul 21, 2020
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ services:
image: "docker.elastic.co/elasticsearch/elasticsearch:6.6.1"
environment:
discovery.type: "single-node"
expose:
- "9200"

indexer:
build:
Expand Down
26 changes: 6 additions & 20 deletions ui/README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,16 @@
# Evidence
# Evidence user interface

## Local setup
User interface consists of

Create single data directory for all models / input data

mkdir data

Obtain `TargetSize150.zip`, unpack and move into data directory

unzip -qq TargetSize150.zip && mv TargetSize150/* data && rmdir TargetSize150

Obtain `doc2vec.csv`, then store in data directory

mv doc2vec.csv data
* a web service written in Go language in current folder.
* a single page web application written in React in `ui/` folder.

## Run

After local deploy (requires ./data setup as per "Local setup" instructions)

docker-compose up --build

Add a user:

curl -XPOST http://localhost:3000/users -d '${username}'
See [../README.md#steps-to-get-the-frontend-up-and-running](../README.md#steps-to-get-the-frontend-up-and-running).
sverhoeven marked this conversation as resolved.
Show resolved Hide resolved

## Elastic search example queries
sverhoeven marked this conversation as resolved.
Show resolved Hide resolved

List of snippets:

http://localhost:8080/es/snippets/_search
Expand Down
8 changes: 4 additions & 4 deletions ui/ui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ User interface of Evidence.

- Run in ./ui: `npm install`

## Build
## Build & run

- Use Dockerfile, one level up.
- When React app and Go web service (one level up) are not being hosted from same web server then
set host of Go web service with env var `REACT_APP_HOST` when building React app Docker image.
See [../README.md#steps-to-get-the-frontend-up-and-running](../README.md#steps-to-get-the-frontend-up-and-running).
sverhoeven marked this conversation as resolved.
Show resolved Hide resolved

To run Go web service (one level up) and React app from different hosts then the React app must be build with env var `REACT_APP_HOST` set to the host URL of Go web service.
sverhoeven marked this conversation as resolved.
Show resolved Hide resolved

## React Starter App

jspaaks marked this conversation as resolved.
Show resolved Hide resolved
Expand Down