diff --git a/AdminWebApp/package.json b/AdminWebApp/package.json index 0aa4ae2a4..cff9b70ef 100644 --- a/AdminWebApp/package.json +++ b/AdminWebApp/package.json @@ -47,7 +47,7 @@ "eslint": "^6.7.2", "eslint-plugin-vue": "^6.1.2", "prismjs": "^1.23.0", - "sass": "^1.30.0", + "sass": "~1.30.0", "sass-loader": "^8.0.0", "tslib": "^2.0.3", "typescript": "~3.7.5", diff --git a/package.json b/package.json index dbab01b08..08d0cb27f 100644 --- a/package.json +++ b/package.json @@ -19,10 +19,10 @@ "docker:postgres:clean": "docker stop $(docker ps -q --filter ancestor=deep-lynx-postgres:latest) && docker rmi deep-lynx-postgres:latest -f", "watch": "nodemon", "start-with-web": "npm run build:dev-with-web && node -r dotenv/config ./dist/main.js", - "start": "node -r dotenv/config ./dist/main.js", + "start": "tsc && copyfiles -u 1 \"./src/**/*.hbs\" ./dist && copyfiles -u 1 \"src/http_server/assets/**\" ./dist && node -r dotenv/config ./dist/main.js", "migrate": "tsc && node -r dotenv/config ./dist/data_access_layer/migrate.js", - "build:dev-with-web": "npm run build:admin-web-app && tsc && copyfiles -u 1 \"./src/**/*.hbs\" ./dist && copyfiles -u 1 \"src/http_server/assets/**\" ./dist", - "build:dev": "npm run build:dev-with-web", + "build:dev": "npm run build:admin-web-app && tsc && copyfiles -u 1 \"./src/**/*.hbs\" ./dist && copyfiles -u 1 \"src/http_server/assets/**\" ./dist", + "build:dev-with-web": "npm run build:dev", "test": "cross-env TS_NODE_FILES=true npm run test:raw", "test:raw": " cd src/tests && cross-env-shell nyc mocha --exit -r ts-node/register -r dotenv/config --recursive \"**/*.spec.ts\" \"**/**/*.spec.ts\" \"**/**/**/*.spec.ts\" --prof ", "prepare": "husky install", diff --git a/readme.md b/readme.md index 1c26c41b9..7255c13d2 100644 --- a/readme.md +++ b/readme.md @@ -20,6 +20,7 @@ The construction of megaprojects has consistently demonstrated challenges for pr - **Required** - PostgreSQL ^11.x **Installation** +You must follow these steps in the exact order given. Failure to do so will cause Deep Lynx to either fail to launch, or launch with problems. **Steps** 1. NodeJS must be installed. You can find the download for your platform here: https://nodejs.org/en/download/ **note** - Newer versions of Node may be incompatible with some of the following commands. The most recent version tested that works fully is 16.13.0 - the latest LTS version. @@ -35,7 +36,7 @@ The construction of megaprojects has consistently demonstrated challenges for pr - Verify that image is properly created. See below. - Run `npm run docker:postgres:run` to run the created docker image (For Mac users, there is an alternative command `npm run mac:docker:postgres:run`). 7. Run `npm run migrate` to create the database and schema within a PostgreSQL database configured in the `.env` file. -8. Run `npm run build:dev` to build the internal modules and bundled administration GUI. +8. Run `npm run build:dev` to build the internal modules and bundled administration GUI. **Note** You must re-run this command ONLY if you make changes to the bundled administration GUI. Changes to the source code of Deep Lynx itself will be captured either with the `npm run watch` command or the next time the user runs `npm run start`. 9. A private key file is required to start Deep Lynx. This file is used for various processes related to user management, data export, etc. A key file can be created by simply using the [OpenSSL](https://www.openssl.org/) library. A command such as `openssl genrsa -out private-key.key 2048` will create a private key that will be safely ignored by the `.gitignore`. After the private key file is created, please provide the path to it with the `ENCRYPTION_KEY_PATH` environment variable. 10. Run `npm run watch` or `npm run start` to start the application. See the `readme` for additional details and available commands.