Skip to content

Privacy-first password manager with built-in email aliasing. Fully encrypted and self-hostable.

Update docs (#2439)

Leendert de Borst3c764d42ed12
diff --git a/dockerfiles/all-in-one/Dockerfile b/dockerfiles/all-in-one/Dockerfile
index bd750b0bc..29f4cdda9 100644
--- a/dockerfiles/all-in-one/Dockerfile
+++ b/dockerfiles/all-in-one/Dockerfile
@@ -51,7 +51,7 @@ COPY apps/server/ ./apps/server/
WORKDIR /src/apps/server
-# Restore only the published projects explicitly (not the legacy Blazor WASM client)
+# Restore only the published projects explicitly (not the test projects)
RUN for project in AliasVault.Api/AliasVault.Api.csproj AliasVault.Admin/AliasVault.Admin.csproj Services/AliasVault.SmtpService/AliasVault.SmtpService.csproj Services/AliasVault.TaskRunner/AliasVault.TaskRunner.csproj Utilities/AliasVault.InstallCli/AliasVault.InstallCli.csproj; do \
dotnet restore "$project" || exit 1; \
done
diff --git a/docs/docs/contributing/development/development-setup.md b/docs/docs/contributing/development/development-setup.md
index f817c7dd8..dbfb093d9 100644
--- a/docs/docs/contributing/development/development-setup.md
+++ b/docs/docs/contributing/development/development-setup.md
@@ -15,7 +15,7 @@ Note for Windows users: the AliasVault development tooling is built around Linux
- **.NET 10 SDK**: https://dotnet.microsoft.com/download/dotnet/10.0
- **Docker Desktop**
- **`dotnet-ef`** tools, if you'll touch the database: `dotnet tool install --global dotnet-ef`
-- **Rust** The AliasVault apps depend on the Rust core, which needs to be compiled locally. Install [rustup](https://rustup.rs), then `rustup target add wasm32-unknown-unknown` and `cargo install wasm-pack`. Build the core with `./core/rust/build.sh --browser`.
+- **Rust** The AliasVault apps depend on the Rust core, which needs to be compiled locally. Install [rustup](https://rustup.rs), then `rustup target add wasm32-unknown-unknown` and `cargo install wasm-pack`. Build the core with `./core/rust/build.sh --web`.
## Running the apps
@@ -27,7 +27,7 @@ a terminal per app (or the VS Code tasks, which fan out one call per app):
```bash
./scripts/dev.sh db-start # start the dev database first (db-stop to stop it)
./scripts/dev.sh api # the API
-./scripts/dev.sh client # the Blazor client (writes its dev appsettings for you)
+./scripts/dev.sh web # the web app (writes its dev appsettings for you)
./scripts/dev.sh admin # the admin web app
./scripts/dev.sh # no argument → interactive menu
./scripts/dev.sh ports # print the resolved port map (defaults: API 5100, db 5109)
@@ -38,32 +38,29 @@ shows which ports it expects.
### Tailwind CSS
-The Admin and Client projects compile their CSS with Tailwind:
+The Admin project compiles its CSS with Tailwind:
```bash
-cd apps/server/AliasVault.Admin && npm run build:admin-css
-cd apps/server/AliasVault.Client && npm run build:client-css
+cd apps/server/AliasVault.Admin && npm run build:admin-css
```
-### Dev client settings
-
-`./scripts/dev.sh client` generates `wwwroot/appsettings.Development.json` with the
-correct `ApiUrl` for your ports automatically. Only create it manually if you run
-the client some other way:
-
-```json
-{
- "ApiUrl": "http://localhost:5100",
- "PrivateEmailDomains": ["example.tld"],
- "SupportEmail": "[email protected]",
- "UseDebugEncryptionKey": "true",
- "CryptographyOverrideType": "Argon2Id",
- "CryptographyOverrideSettings": "{\"DegreeOfParallelism\":1,\"MemorySize\":1024,\"Iterations\":1}"
-}
-```
+### Web app settings
+
+`./scripts/dev.sh web` generates `apps/web/public/appsettings.Development.json` with the
+correct `ApiUrl` for your ports automatically, and starts the Vite dev server.
### E2E tests (Playwright)
+The web app and the browser extension have their own Playwright suites, which run against a running Debug API
+(`./scripts/dev.sh api`):
+
+```bash
+cd apps/web && npm run test:e2e
+cd apps/browser-extension && npm run test:e2e:build
+```
+
+The Admin app is tested by the .NET E2E project:
+
```bash
dotnet tool install --global Microsoft.Playwright.CLI
pwsh apps/server/Tests/AliasVault.E2ETests/bin/Debug/net10.0/playwright.ps1 install
diff --git a/docs/docs/contributing/development/server-webapp.md b/docs/docs/contributing/development/server-webapp.md
index 35a6a9758..100cd54d2 100644
--- a/docs/docs/contributing/development/server-webapp.md
+++ b/docs/docs/contributing/development/server-webapp.md
@@ -4,9 +4,9 @@ sidebar_label: "Server & web app"
---
# Server & web app
-The AliasVault server (the API, the Admin app and the web app/client) is built entirely with [.NET 10](https://dotnet.microsoft.com/) and [Blazor WebAssembly](https://learn.microsoft.com/aspnet/core/blazor/).
+The AliasVault server (the API, the Admin app and the background services) is built with [.NET 10](https://dotnet.microsoft.com/); the Admin app uses [Blazor Server](https://learn.microsoft.com/aspnet/core/blazor/). The web app in `apps/web` is a React app (Vite, TypeScript, Tailwind CSS) that runs on the shared client core in `core/client` and the Rust core compiled to WebAssembly.
-You can open the .NET solution in [Visual Studio 2026+](https://visualstudio.microsoft.com/), [Visual Studio Code](https://code.visualstudio.com/) or [JetBrains Rider](https://www.jetbrains.com/rider/) and work on it like any other .NET project.
+You can open the .NET solution in [Visual Studio 2026+](https://visualstudio.microsoft.com/), [Visual Studio Code](https://code.visualstudio.com/) or [JetBrains Rider](https://www.jetbrains.com/rider/) and work on it like any other .NET project. The web app is a regular npm project.
## Running it locally
@@ -15,8 +15,10 @@ The recommended way to run the server apps from source is via `./scripts/dev.sh`
```bash
./scripts/dev.sh db-start # start the dev database
./scripts/dev.sh api # the API
-./scripts/dev.sh client # the Blazor WASM web app
+./scripts/dev.sh web # the web app
./scripts/dev.sh admin # the Admin app
```
You can also run or debug any of these projects directly from your IDE; run `./scripts/dev.sh ports` to see which ports each one expects.
+
+The web app needs the Rust core built for the browser once (`cd apps/web && npm run build:rust`) before `npm install`.