Peel

.env

@@ -0,0 +1,2 @@
+VUE_APP_SERVER_URL = http://localhost:5000
+# VUE_APP_SERVER_URL = https://internal.forensic-architecture.org/mtriage-server

.gitignore

@@ -1,11 +1,26 @@
-.vscode/
 .DS_Store
+node_modules
+dist
+src/assets/class_vid*
+src/assets/test*
 
+# local env files
+.env.local
+.env.*.local
+
+# Log files
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Editor directories and files
+.idea
+.vscode
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw*
 tags
 tags.lock
 tags.temp
-
-server/mtbatches/
-server/__pycache__
-
-viewer/.env

README.md

@@ -1,26 +1,30 @@
-# mtriage-viewer
+# example
 
-#### note: pre-alpha development, not ready for use. Everything will break!
+## Project setup
+```
+npm install
+cp example.env .env
+```
 
-mtriage-viewer is a server collected with a web frontend to interactively
-visualise [mtriage](https://github.com/forensic-architecture/mtriage) workflows
-after they have been run.
+### Compiles and hot-reloads for development
+```
+npm run serve
+```
 
-## Run the server
+### Compiles and minifies for production
 ```
-cd server
-poetry install
-poetry shell
-export FLASK_ENV=development
-python app.py
+npm run build
 ```
 
-Modify `ROOT` and `STORAGE_TYPE` variables inside app.py to point to another
-storage location.
+### Run your tests
+```
+npm run test
+```
 
-## Run the frontend
+### Lints and fixes files
 ```
-cd viewer
-npm install
-npm run dev
+npm run lint
 ```
+
+### Customize configuration
+See [Configuration Reference](https://cli.vuejs.org/config/).