Installation
This guide walks you through setting up the ACTS ML dashboard locally for development.
Prerequisites
- Node.js
^20.19.0or>=22.12.0 - npm (comes with Node.js)
- Git
Clone the Repository
git clone https://github.com/ACTS/acts-ml.git
cd acts-ml
Install Dependencies
npm install
Environment Setup
Create a .env file in the project root with the following variables:
VITE_DIRECTUS_URL=https://your-api-instance.com/v1/api/d
VITE_DIRECTUS_WEBSOCKET_URL=wss://your-api-instance.com/v1/api/d
| Variable | Description |
|---|---|
VITE_DIRECTUS_URL | The Directus API endpoint for your ACTS ML backend |
VITE_DIRECTUS_WEBSOCKET_URL | WebSocket URL for real-time updates |
Start the Development Server
npm run dev
The application will be available at http://localhost:5173.
Available Scripts
| Command | Description |
|---|---|
npm run dev | Start development server with hot reload |
npm run build | Build for production (includes type checking) |
npm run preview | Preview the production build locally |
npm run test:unit | Run unit tests with Vitest |
npm run test:e2e | Run end-to-end tests with Playwright |
npm run lint | Lint code with ESLint and Oxlint |
npm run format | Format code with Prettier |
Next Steps
Once the application is running, head to the Quick Start guide to create your first project.