Skip to content

Commit

Permalink
minor changes to README.md, env requirements
Browse files Browse the repository at this point in the history
Signed-off-by: James Kunstle <[email protected]>
  • Loading branch information
JamesKunstle committed Feb 12, 2024
1 parent 71a921c commit 18a92ca
Showing 1 changed file with 32 additions and 8 deletions.
40 changes: 32 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,24 +40,40 @@ The file-structure of our application is intuitive. Non-application files are om
| +-- index/
| +-- index_callbacks.py
| +-- index_layout.py
+-- overview/
| +-- overview.py
+-- welcome/
| +-- welcome.py
| +-- visualizations/
| +-- name_of_visualization_1.py
| ...
| +-- name_of_visualization_n.py
+-- contributions/
| +-- contributions.py
| +-- visualizations/
| ...
+-- contributors/
| +-- cntrb_behavior.py
| +-- cntrb_type.py
| +-- visualizations/
| ...
+-- chaoss/
| +-- chaoss.py
| +-- visualizations/
| +-- name_of_visualization_1.py
| ...
| +-- name_of_visualization_n.py
+-- home/
| +-- home.py
+-- affiliation/
| +-- affiliation.py
| +-- visualizations/
| ...
+-- codebase/
| +-- codebase.py
| +-- visualizations/
| ...
+-- visualization_template/
| +-- viz_template.py
+-- utils/
+-- app.py
+-- _celery.py
+-- _login.py
+-- _bots.py
.
.
.
Expand All @@ -66,7 +82,7 @@ The file-structure of our application is intuitive. Non-application files are om

The application 'Dash' instance is defined in the 'app.py' file, as is the app.server object that our WSGI server uses, and the manager for the task-queue.

The 'Dash' application instance imports the application's base layout from the '/pages/index/index_layout.py' file. The logic to process user input to components laid out in this file (search bar, page selectors) is defined in '/pages/index/index_callbacks.py.'
The 'Dash' application instance imports the application's base layout from the '/pages/index/index_layout.py' file. The logic to process user input to components is laid out in this file (search bar, page selectors) is defined in '/pages/index/index_callbacks.py.'

Each page of the application is in its own 'pages' folder. On each page a variety of metrics and figures are rendered. These, for each page, are in the 'page_name/visualizations/' folder, and are imported into the file 'page_name.py.'

Expand Down Expand Up @@ -139,6 +155,8 @@ The credentials below are valid, so you can copy and use them to access a develo
8KNOT_DEBUG=True
REDIS_PASSWORD=1234
DEFAULT_SEARCHBAR_LABEL=chaoss
POSTGRES_PASSWORD=somepassword
SECRET_KEY=somethingsecret
```

If you have a companion Augur front end application you'll need to set the following credentials in the env.list as well.
Expand All @@ -159,6 +177,12 @@ application's owner.
AUGUR_ADMIN_NAME_ENDPOINT=<endpoint>/api/unstable/application/
AUGUR_ADMIN_GROUP_NAMES_ENDPOINT=<endpoint>/api/unstable/application/groups/names
AUGUR_ADMIN_GROUPS_ENDPOINT=<endpoint>/api/unstable/application/group/repos
OAUTH_CLIENT_NAME=augur
OAUTH_CLIENT_ID=<id>
OAUTH_CLIENT_SECRET=<secret>
OAUTH_AUTHORIZE_URL=<url>
OAUTH_TOKEN_URL=<url>
OAUTH_REDIRECT_URI = localhost:8080/
```

Note: You'll have to manually fill in the \<AUGUR_APP_ID\> in the AUGUR_USER_AUTH_ENDPOINT environment variable.
Expand Down Expand Up @@ -217,7 +241,7 @@ ctrl-c
To clean up the stopped containers, run:

```bash
docker compose down
docker compose down --volumes
```

The application should be available locally at 'http://localhost:8080'
Expand Down

0 comments on commit 18a92ca

Please sign in to comment.