Readme changes and package bumps

forensic-architecture · Jul 23, 2023 · 324ac39 · 324ac39
1 parent 4ace636
commit 324ac39
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -19,6 +19,10 @@ Modify `ROOT` and `STORAGE_TYPE` variables inside app.py to point to another
 storage location.
 
 ## Run the frontend
+
+NOTE: Must use Node v16. You're likely on a newer version, but will need to downgrade in order to view. We recommend using [node version manager](https://github.com/nvm-sh/nvm) in the (likely) case you have multiple versions of node on your computer. Once installed just run `nvm install 16` and `nvm use 16` and you should be set. 
+
+
 ```
 cd viewer
 npm install

diff --git a/server/README.md b/server/README.md
@@ -1,4 +1,7 @@
 ## Run in development
+
+NOTE: if you are using poetry >= 1.22, you should first run ``poetry config experimental.new-installer false`` to use the old installer. You can check your poetry version with ``poetry --version``.
+
 ```
 poetry install
 poetry run python app.py

diff --git a/server/app.py b/server/app.py
@@ -27,8 +27,8 @@ class StorageType(Enum):
     S3 = 2
 
 
-ROOT = "lk-iceland-personal"
-STORAGE_TYPE = StorageType.S3
+ROOT = "/Users/focus/Downloads/derived/KerasPretrained"
+STORAGE_TYPE = StorageType.Local
 
 
 def read_etype(local_fp: Path) -> str:

diff --git a/viewer/README.md b/viewer/README.md
@@ -1,14 +1,17 @@
 # example
 
+NOTE: mtriage-viewer was built with Node 16. You're likely on a newer version, but will need to downgrade in order to view. We recommend using [node version manager](https://github.com/nvm-sh/nvm) in the (likely) case you have multiple versions of node on your computer. Once installed just run `nvm install 16` and `nvm use 16` and you should be set. 
+
 ## Project setup
 ```
 npm install
 cp example.env .env
 ```
 
-### Compiles and hot-reloads for development
+## Compiles and hot-reloads for development
+
 ```
-npm run serve
+npm run dev
 ```
 
 ### Compiles and minifies for production
@@ -27,4 +30,4 @@ npm run lint
 ```
 
 ### Customize configuration
-See [Configuration Reference](https://cli.vuejs.org/config/).
+See [Configuration Reference](https://cli.vuejs.org/config/).
diff --git a/viewer/package.json b/viewer/package.json
@@ -7,17 +7,17 @@
     "dev": "vue-cli-service serve"
   },
   "dependencies": {
-    "axios": "^0.19.2",
+    "axios": "^1.4.0",
     "chokidar": "^3.4.3",
     "core-js": "^3.6.5",
     "vue": "^2.6.12",
     "vuetify": "^2.3.10",
     "vuex": "^3.5.1"
   },
   "devDependencies": {
-    "@vue/cli": "^4.5.6",
-    "@vue/cli-plugin-babel": "^4.5.6",
-    "@vue/cli-service": "^4.5.6",
+    "@vue/cli": "^5.0.8",
+    "@vue/cli-plugin-babel": "^5",
+    "@vue/cli-service": "^5.0.8",
     "sass": "^1.26.10",
     "sass-loader": "^10.0.2",
     "vue-template-compiler": "^2.6.12"