Merge pull request #46 from kabilar/dashboard2

Add dashboard page

Author: kabilar

docs/dashboard.md

@@ -0,0 +1,20 @@
+# LINC Dashboard
+
+The [LINC Dashboard](https://dashboard.lincbrain.org) summarizes the data on [lincbrain.org](https://lincbrain.org).
+
+Excluded from the dashboard are datasets `000048` (OpenBNB) and `000004` (Mouse LSM) since they were not acquired as part of LINC milestones.
+
+## Developer documentation
+
+### Architecture
+
+- The front-end is built with the Streamlit framework and deployed with Streamlit's Community Cloud.
+- The metadata is extracted using a GitHub Action and the CSV files are uploaded to a private AWS S3 bucket.
+
+### Run application locally
+
+Follow the instructions below to run the application locally:
+1. Fork and clone the [linc-dashboard](https://github.com/lincbrain/linc-dashboard) repository.
+2. Install the dependencies using `pip install -r requirements.txt`.
+3. Run the application with `streamlit run app.py`.
+4. Run the script to extract metadata with `python extract_metadata.py`.  Note, by default the application displays the data from S3.

mkdocs.yml

@@ -31,6 +31,7 @@ theme:
 nav:
   - Welcome: "index.md"
   - Upload data: "upload.md"
+  - Dashboard: "dashboard.md"
   - Visualize data in Neuroglancer: "neuroglancer.md"
   - Webknossos:
     - Add Webknossos dataset: "webknossos-add-dataset.md"