progmaweb
The site and account service of Progmasoft: a Next.js frontend and an ASP.NET Core API.
Clonegit clone https://git.progmasoft.com/progmaweb
mainroot / README.md
<!-- SPDX-FileCopyrightText: 2026 Progmasoft <support@progmasoft.com> -->
<!-- SPDX-License-Identifier: AGPL-3.0-or-later -->
# Progmaweb
Progmaweb is the public web and account surface for Progmasoft. The repository intentionally keeps presentation and
account policy in one deployable workspace while preserving a strict process boundary between the Next.js frontend and
the ASP.NET Core API.
## Public hosts
- `progmasoft.com` serves the organization homepage, the Privacy Policy and the Security Policy;
`www.progmasoft.com` redirects to it.
- `account.progmasoft.com` serves the account: sign-in (`/login`), registration (`/register`), recovery (`/recover`)
and the dashboard (`/<Account>/dashboard`).
- `credentials.progmasoft.com`, `authorize.progmasoft.com` and `console.progmasoft.com` serve Progmasoft OAuth: the
issuer, the pages people sign in and consent on, and the Progmasoft Console. See [Progmasoft OAuth](docs/OAUTH.md).
- `product.progmasoft.com` serves the product catalog, and `license.progmasoft.com` the Progmasoft Source License.
- `agencelandmcp.progmasoft.com` serves the Agenceland MCP Marketplace, which lists no server and takes no uploads.
- `git.progmasoft.com` serves the read-only mirrors of the repositories: pages from Next.js, raw files and archives from
the API, clones from git-http-backend.
The same Nginx file also answers `viget.progmasoft.com` with 410 Gone, sends `catch3.progmasoft.com` to `catch3.uk`,
and serves the Maven repository on `maven.progmasoft.com`; [Operations](ops/README.md) describes those and the other
sites of the server.
Account names preserve their original display case but reserve names case-insensitively, preventing visually confusing
duplicates. Email uniqueness is also evaluated case-insensitively by the API.
## Languages
Every page is published in English, German, Russian and French. A visitor who has not chosen a language gets the
language their browser prefers, and English when the browser prefers none of the four. A choice made in the language
menu is remembered across the three hosts. See [Localization](docs/LOCALIZATION.md).
## Documentation
- [Architecture](docs/ARCHITECTURE.md): processes, hosts, routing and trust boundaries.
- [Account API](docs/ACCOUNT-API.md): endpoints, errors, cookies and limits.
- [Progmasoft OAuth](docs/OAUTH.md): the authorization server, the console and how an application uses them.
- [Localization](docs/LOCALIZATION.md): language selection, text direction and adding a language.
- [Development](docs/DEVELOPMENT.md): local setup, checks and what CI enforces.
- [Known limitations](docs/LIMITATIONS.md): what is missing or temporary. Read this before operating the service;
accounts and sessions are kept in PostgreSQL and survive a restart of the API.
- [Operations](ops/README.md) and the [mail boundary](ops/mail/README.md).
## Architecture
- `apps/web` is a Next.js App Router application. Host-aware routing keeps the organization, account, OAuth, console,
product and license sites in one build without coupling their page hierarchies.
- `apps/api` is an ASP.NET Core minimal API. It owns account-name policy, password hashing, sessions, secure cookies,
rate limiting, and Progmasoft OAuth (OpenIddict) with the applications of the console.
- The browser never receives password hashes, session digests, deployment secrets, or database credentials.
- Production account maintenance is an explicit operations workflow. The public API does not contain bulk-delete,
reset-all, seed-password, or environment-password endpoints.
## Requirements
- Node.js 24 or newer
- pnpm 11 or newer
- .NET SDK 10
The initial Progmaweb release, Git tag, and GitHub Release use version `1.0.0`.
## Development
Install frontend dependencies and start Next.js:
```text
pnpm install --frozen-lockfile
pnpm dev
```
Start the account API in another terminal:
```text
dotnet run --project apps/api/Progmaweb.Api.csproj --urls http://127.0.0.1:5085
```
The frontend defaults to `http://127.0.0.1:5085` for server-side API requests. Set `PROGMAWEB_API_ORIGIN` when the API
uses another origin. Browser requests use the same-origin `/api` boundary so production can proxy them without exposing
an internal address.
Google sign-in uses a server-side authorization-code flow. Configure `Authentication__Google__ClientId` and
`Authentication__Google__ClientSecret` only in the process environment or secret manager. The production OAuth client
uses `https://account.progmasoft.com` as its JavaScript origin and
`https://account.progmasoft.com/api/v1/accounts/oauth/google/callback` as its exact redirect URI. Never commit the
downloaded Google client JSON.
## Verification
```text
pnpm check
pnpm test
pnpm test:coverage
pnpm build
pnpm --filter @progmasoft/web exec playwright install chromium
pnpm test:layout
dotnet build apps/api/Progmaweb.Api.csproj --configuration Release
dotnet test --project apps/api-tests/Progmaweb.Api.Tests.csproj --configuration Release
dotnet test --project apps/api-tests/Progmaweb.Api.Tests.csproj --configuration Release --coverlet --coverlet-output-format cobertura
dotnet tool restore
dotnet docfx docs/api/docfx.json --warningsAsErrors
dotnet run docs/api/CheckDocumentation.cs -- docs/api
```
Frontend tests exercise the published locale contract and account metadata without starting a production service.
`pnpm test:layout` runs the built site with `next start` and opens one page of each kind on every host in Chromium at
360, 390, 768 and 1280 pixels; every host name resolves to the local server, so no request leaves the machine. It
fails when anything reaches past the edge of the screen, a header takes more than one line or covers its own brand,
a control is smaller than 24 by 24 pixels, or the header menu of a phone does not open and close.
The frontend LCOV and API Cobertura reports are retained as one-day artifacts, then uploaded to Codecov by separate
jobs. Only those upload jobs receive `id-token: write`; dependency installation, builds, and tests do not receive OIDC
permissions, and fork-originated pull requests skip the upload jobs. CodeQL and Codacy provide static analysis;
Renovate proposes dependency updates without merging them automatically; Dependabot reports vulnerabilities and proposes their fixes. The DocFX command builds the API reference
and fails on a broken link or an unresolved reference; the check after it fails when any item of the reference has no
description. [Development](docs/DEVELOPMENT.md) explains each check.
## License
Progmaweb project-owned source code is licensed under `AGPL-3.0-or-later`, with the
additional Progmasoft Patent Grant, Version 1.1. See `LICENSE.txt`, `PATENTS.md`,
`LICENSES/AdditionRef-Progmasoft-Patent-Grant-1.1.txt`, and `NOTICE.txt`. Third-party dependencies remain under their
respective licenses.