Workstation requirements

Before you Start

🔥 This feature is currently considered experimental. Try it out and give feedback by reporting bugs and suggesting new features. It’s not recommended for production use.

💻 This feature is available to developers.

Use this checklist to prepare a developer workstation before you start building or extending Sirius Web. It complements the server-side requirements listed in the installation guide and focuses on the tools you need locally to run the training labs, compile the backend, and build the frontend.

1. Operating system

Sirius Web development works on any recent 64-bit desktop OS:

Windows 10 or later
macOS 13 Ventura or later
Linux distributions with good Docker support (Ubuntu LTS, Fedora, Debian, etc.)

2. Core tooling

Tool Version / Notes Verification

Tool	Version / Notes	Verification
Git & Git Bash (Windows)	Install Git for your platform; on Windows add Git Bash to get a Unix-like shell that matches the training scripts.	`git --version` and (on Windows) run `ls -la` inside Git Bash to confirm the shell works.
Java Development Kit	Temurin JDK 21 (same runtime used by the server). Install it even if you rely on IDE-managed JDKs so Maven and the CLI can run.	`java -version`
Maven	Apache Maven 3.9.x.	`mvn -version`
Node.js & npm	Node.js 22.16.0 (npm 10.2.3). Use NVM for easy upgrades: * Windows: https://github.com/coreybutler/nvm-windows * Linux/macOS: https://github.com/nvm-sh/nvm	`node -v` and `npm -v`
Docker Desktop / Engine	Latest stable release, configured to allocate at least 4 GB RAM. Required for local PostgreSQL and the sample deployments used in trainings.	`docker --version`
GitHub account & PAT	Create a GitHub account and generate a personal access token with the `read:packages` scope to pull private artifacts when required.	Log in with `gh auth login` or use the token when cloning; store it securely (password manager or OS keychain).

Git & Git Bash (Windows)

Install Git for your platform; on Windows add Git Bash to get a Unix-like shell that matches the training scripts.

git --version and (on Windows) run ls -la inside Git Bash to confirm the shell works.

Java Development Kit

Temurin JDK 21 (same runtime used by the server). Install it even if you rely on IDE-managed JDKs so Maven and the CLI can run.

java -version

Maven

Apache Maven 3.9.x.

mvn -version

Node.js & npm

Node.js 22.16.0 (npm 10.2.3). Use NVM for easy upgrades: * Windows: https://github.com/coreybutler/nvm-windows * Linux/macOS: https://github.com/nvm-sh/nvm

node -v and npm -v

Docker Desktop / Engine

Latest stable release, configured to allocate at least 4 GB RAM. Required for local PostgreSQL and the sample deployments used in trainings.

docker --version

GitHub account & PAT

Create a GitHub account and generate a personal access token with the read:packages scope to pull private artifacts when required.

3. Recommended IDEs and extensions

Backend: IntelliJ IDEA or VS Code with Java tooling.
Frontend: VS Code or WebStorm with TypeScript support.
Docker: Docker Desktop (UI) or Lens for inspecting containers.
GraphQL clients: Altair, GraphiQL, or IDE plugins to test queries.

Any IDE is acceptable as long as it respects the Maven/Node toolchains above.

4. Network and security

Ensure you can reach GitHub over HTTPS (corporate proxies may require extra configuration).
Allow Docker to download images from docker.io.
Some corporate antivirus tools aggressively scan Docker volumes or Node modules; whitelist your workspace if you notice build slowdowns.

5. Quick validation script

Create a scratch directory and run:

git --version
java -version
mvn -version
node -v
npm -v
docker --version

If every command reports the expected version, your workstation is ready to develop.