Dashboard

.gitattributes

@@ -0,0 +1,4 @@
+registry/static/vue-build/* binary
+registry/static/vue-build/*/* binary
+registry/templates/vue-build/* binary
+registry/templates/vue-build/*/* binary

.github/workflows/lint.yml

@@ -9,12 +9,13 @@ jobs:
     - name: Setup python
       uses: actions/setup-python@v2
       with:
-        python-version: 3.6
+        python-version: 3.8
         architecture: x64
     - uses: actions/cache@v1
       with:
         path: ~/.cache/pip
         key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements_dev.txt') }}
     - run: pip install -r requirements_dev.txt
+    - run: pip install -r requirements.txt
     - run: flake8 .
 

.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: Test
+name: Test registry
 on: [push, pull_request]
 
 jobs:
@@ -9,12 +9,14 @@ jobs:
     - name: Setup python
       uses: actions/setup-python@v2
       with:
-        python-version: 3.6
+        python-version: 3.8
         architecture: x64
     - uses: actions/cache@v1
       with:
         path: ~/.cache/pip
         key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements_dev.txt') }}
     - run: pip install -r requirements_dev.txt
-    - run: python -m pytest
+    - run: pip install -r requirements.txt
+    - run: python -m pytest tests/
+    - run: MODE="dashboard" python -m pytest tests_dashboard/
 

.github/workflows/test_dashboard.yml

@@ -0,0 +1,17 @@
+name: Test dashboard
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Setup node
+      uses: actions/setup-node@v3
+      with:
+        node-version: 18
+        cache: 'npm'
+        cache-dependency-path: registry-vue/package-lock.json
+    - run: cd registry-vue; npm install; npm run build
+    - run: git status
+

.gitignore

@@ -5,6 +5,7 @@
 .vscode/
 
 get-pip.py
+*.pyc
 
 chromedriver/
 __pycache__/

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "360-ds"]
+	path = 360-ds
+	url = https://github.com/ThreeSixtyGiving/360-ds

CHECKS

@@ -0,0 +1,13 @@
+# Dokku checks
+# Require that the app is up (URL returns 200) before migrating traffic.
+#
+# Wait 10 seconds between checks
+WAIT=10
+# Timeout after a minute
+TIMEOUT=6
+# Attempt checks 10 times
+ATTEMPTS=10
+
+# Check root URL
+/
+

Procfile

@@ -1 +1 @@
-web: flask run --host=0.0.0.0 --port=5001
+web: gunicorn registry.views:app

README.md

@@ -8,21 +8,47 @@ To download all the files listed in the registy, the 360Giving [datagetter](http
 
 Install dependencies:
 
+```bash
+python3 -m venv .ve
+source .ve/bin/activate
+pip install -r requirements_dev.txt
 ```
-$ python3 -m venv .ve
-$ source .ve/bin/activate
-$ pip install -r requirements_dev.txt
+
+This project uses pip-tools. To update the requirements files, run:
+
+```bash
+pip-compile requirements.in
+# or
+pip-compile requirements_dev.in
 ```
 
-Run:
+This project uses PyScss. To update the compile css file, run:
 
-Server
+```bash
+pysassc registry/sass/main.scss registry/static/css/theme.css
 ```
-$ export FLASK_APP=registry/views.py
-$ python -m flask run
+
+To run the registry tests:
+```bash
+python -m pytest tests/
 ```
 
-Tests
+To run the dashboard tests:
+```bash
+MODE='dashboard' python -m pytest tests_dashboard/
 ```
-$ python -m pytest
+
+In order to run the application see the relevant commands below:
+
+**Development**
+```bash
+export FLASK_APP=registry/views.py
+export FLASK_ENV=development
+python -m flask run
+```
+
+**Server**
+```bash
+export FLASK_APP=registry/views.py
+python -m flask run
 ```

registry-vue/.env.development

@@ -0,0 +1 @@
+VUE_APP_DATASTORE_API=https://store.data.threesixtygiving.org/api/dashboard/

registry-vue/.env.production

@@ -0,0 +1 @@
+VUE_APP_DATASTORE_API=https://store.data.threesixtygiving.org/api/dashboard/

registry-vue/.gitignore

@@ -0,0 +1,23 @@
+.DS_Store
+node_modules
+/dist
+
+
+# local env files
+.env.local
+.env.*.local
+
+# Log files
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+# Editor directories and files
+.idea
+.vscode
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

registry-vue/README.md

@@ -0,0 +1,38 @@
+# registry-vue2
+
+## Project setup
+```
+npm install
+```
+
+### Compile theme
+Make sure the git submodule is checked out and the theme is compiled
+```
+cd 360-ds
+npm install
+npm run compile-sass -- --path ../registry-vue/src/assets/styles/
+```
+
+
+### Compiles and hot-reloads for development
+```
+npm run serve
+```
+
+### Compiles and minifies for production
+```
+npm run build
+```
+
+### Lints and fixes files
+```
+npm run lint
+```
+
+### Customize configuration
+See [Configuration Reference](https://cli.vuejs.org/config/).
+
+# Registry, Flask, Vue and You
+
+At present the vue application is set to build into the flask application at the default folders in the subdirectory `vue-build`.
+You can run the vue application for development as above (i.e. `npm run serve`), but you can also do a production build into the flask application and run it through flask as per the root `README.md`.

registry-vue/babel.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+  presets: [
+    '@vue/cli-plugin-babel/preset'
+  ]
+}