Heimdall (heimdall)

Heimdall is an application management portal for all your web applications. This version is the JavaScript rewrite of the original PHP version of Heimdall.

Development Environment Setup

Building Heimdall requires a modern release of Node.js (the CI environment uses Node.js 14). Having a compatible version of Node, yarn and the @quasar/cli package installed is necessary to run the commands listed below. In addition, you will need to run this command in order to resolve the dependencies:

npm install

Install

npm run setup

When asked Where will the API live?, the default / will work for most people, however, if you wish to run the app in development mode set it to http://localhost:3000/

Run the backend server

npm run server

By default both the server and frontend will be accessible on port 3000

Start the front end app in development mode (hot-code reloading, error reporting, etc.)

quasar dev

Front end will be accessible on port 8080. Running the app in this way does not include a backend server, so ensure you've run npm run server before starting up the front end

Lint the files

yarn run lint

Run unit tests

yarn test

Build the app for production

quasar build

Rebuild database tables (in case of schema/data changes)

Install the sequelize-cli, or use npx:

sequelize-cli db:seed:undo
sequelize-cli db:seed:all

Running sequelize-cli db:seed:all multiple times will fail currently, as it is attempting to re-insert the same rows multiple times. Clear the data using db:seed:undo first.