Spaced

Prerequisites

In order to run Spaced in development the following must be installed.

• NodeJS 18
• Rust
• Tauri
• sqlx-cli

If you're using Nix, you can run nix-shell, or configure direnv to install the required Tauri dependencies (and Playwright browsers).

You can choose either Docker or Podman. Docker is used in the pipeline and deployments as it provides Swarm support with the docker stack command.

Docker	Podman
Docker => v20.10	Podman
Docker Compose	Podman Compose

Getting started

Install dependencies for web-frontend.

npm ci

Prepare the database with migrations.

npm run sqlx:prepare -- --tauri
# Or for all databases at the same time with:
# npm run sqlx:prepare

The services can be started with the following commands.

cargo run -i item_socket
# cargo run -i item_producer # Not used atm
# cargo run -i user_service  # Not used atm

The web-frontend can be started with the following script.

npm run dev

The web-frontend can also be displayed from a desktop application with the following command.

npm run tauri dev

Building

The web-frontend can be built using the following script.

npm run build

The docker images for each service can be built using the following command.

docker compose --profile services build
# Or also directly started with:
# docker compose --profile services up -d --build

Use the following environment variable to change the image tag.

IMAGE_TAG=1.0 docker compose --profile services build

Use the following environment variable to change the distroless image tag. The default is nonroot, to debug with a shell use debug or debug-nonroot.

DISTROLESS_TAG=debug docker compose --profile services build

Contributing

Please read the contributing guidelines.

License

The project is licensed under a MIT license.

Some workspace members (or files) contain their own MIT License copies, as they are derivative works (packages).