Skip to content

development.md

Latest commit

 

History

History
57 lines (37 loc) · 1.44 KB

development.md

File metadata and controls

57 lines (37 loc) · 1.44 KB
Raw

Development guide

The SimDB dashboard frontend is a Vite/Vue single-page app. The recommended development workflow is to run the Vite dev server through Make using Docker.

Setting up a development environment

  1. Clone the repository:
git clone git@github.com:iterorganization/SimDB-Dashboard.git
cd SimDB-Dashboard
  1. Start the development server with hot reload:
make dev
  1. Open the app in your browser:
http://localhost:5173/dashboard/

The make dev target runs the Docker dev stage and starts Vite with live reload enabled. Source changes under dashboard/ are mounted into the container and reflected immediately.

Other useful commands

Run lint checks:

make lint

Run unit tests:

make test

The make lint, make type-check, and make test targets each run docker run against the prebuilt simdb-dashboard:build image, so make build (or make service) must be run first.

Run type checks:

make type-check

At the moment, the project does not include test files, so make test will exit with no tests found.

Releases and image tags

Pushing a tag makes CI publish a versioned image and a GitHub Release, and moves latest; pushes to develop move develop. The version comes from git describe --tags, so tag releases as plain versions (0.9.0) and don't leave stray tags around. See Published image tags.