updates to the sequelize-cli-windows and README

Signed-off-by: George M Dias <GDIAS@MITRE.ORG>
mitre · May 23, 2024 · afe3398 · afe3398
1 parent e7ee0ce
commit afe3398
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -366,7 +366,7 @@ If you would like to change Heimdall to your needs, you can use Heimdall's 'Deve
      git clone https://github.com/mitre/heimdall2
      ```
 
-3. Run the PostgreSQL server:
+3. Setup the PostgreSQL server:
 
    Ubuntu:
 
@@ -436,17 +436,17 @@ If you would like to change Heimdall to your needs, you can use Heimdall's 'Deve
 
    - ```bash
      cd heimdall2
-     yarn install      # you may need to run yarn install --registry https://registry.npmjs.org
+     yarn install  # you may need to run yarn install --registry https://registry.npmjs.org
      ```
 
-5. Edit your apps/backend/.env file using the provided `setup-dev-env.sh or setup-dev-env.bat` script. Make sure to set a DATABASE_USERNAME and DATABASE_PASSWORD that match what you set for the PostgresDB in step 3.
+5. Edit or generate the database environment configuration file (apps/backend/.env) using the provided `setup-dev-env.sh or setup-dev-env.bat` script. Make sure to set the DATABASE_USERNAME and DATABASE_PASSWORD variables with values used in step 3.
 
-You can also open the apps/backend/.env file in a text editor and set additional optional configuration values. For more info on configuration values see [Environment Variables Configuration](https://github.com/mitre/heimdall2/wiki/Environment-Variables-Configuration).
+You can also edit, if exists, the apps/backend/.env file using a text editor and set additional optional configuration values. For more info on configuration values see [Environment Variables Configuration](https://github.com/mitre/heimdall2/wiki/Environment-Variables-Configuration).
 
 > [!NOTE]
-> The .env file in the root repository is for the Docker deployment of the Heimdall application. Running a local build will use the .env file in the `apps/backend` directory.
+> The .env file in the root repository is for the Docker deployment of the Heimdall application. Running a local build will use the .env file in the `apps/backend` directory for the database configurations.
 
-6. Create the database:
+6. Create and seed the database:
 
    - ```bash
      # Windows

diff --git a/apps/backend/package.json b/apps/backend/package.json
@@ -15,7 +15,7 @@
     "build": "nest build",
     "lint": "eslint \"{src,migrations,seeders,test}/**/*.ts\" --fix",
     "lint:ci": "eslint \"{src,migrations,seeders,test}/**/*.ts\" --max-warnings 0",
-    "sequelize-cli-windows": "node --experimental-loader ts-node/esm node_modules/sequelize-cli/lib/sequelize",
+    "sequelize-cli-windows": "tsx node_modules/sequelize-cli/lib/sequelize",
     "sequelize-cli": "tsx node_modules/.bin/sequelize",
     "start": "node dist/src/main",
     "start:debug": "nest start --debug --watch",