diff --git a/.playwright-mcp/account-dashboard.png b/.playwright-mcp/account-dashboard.png new file mode 100644 index 0000000..48048e8 Binary files /dev/null and b/.playwright-mcp/account-dashboard.png differ diff --git a/.playwright-mcp/login-page.png b/.playwright-mcp/login-page.png new file mode 100644 index 0000000..0f9053a Binary files /dev/null and b/.playwright-mcp/login-page.png differ diff --git a/.playwright-mcp/register-page.png b/.playwright-mcp/register-page.png new file mode 100644 index 0000000..9c40393 Binary files /dev/null and b/.playwright-mcp/register-page.png differ diff --git a/changelog.md b/changelog.md index 496570c..51ce7b5 100644 --- a/changelog.md +++ b/changelog.md @@ -1,5 +1,12 @@ # Changelog +## 2026-01-29 - 1.16.0 - feat(dev) +add local development docs, update tswatch preset and add Playwright screenshots + +- readme.md: added a Local Development section with prerequisites, quick-start commands, environment variables, development routes, and default development credentials + security note +- npmextra.json: changed @git.zone/tswatch preset from "website" to "service" and disabled the built-in server (removed port/serveDir/liveReload and set server.enabled false); removed triggerReload from website watcher +- .playwright-mcp: added Playwright screenshots (login-page.png, register-page.png, account-dashboard.png) for visual tests / CI + ## 2026-01-29 - 1.15.0 - feat(build) add tsbundle/tswatch configs, update build/watch scripts, bump dependencies, and add CLI documentation diff --git a/npmextra.json b/npmextra.json index edfed23..6bb4b1f 100644 --- a/npmextra.json +++ b/npmextra.json @@ -63,12 +63,9 @@ ] }, "@git.zone/tswatch": { - "preset": "website", + "preset": "service", "server": { - "enabled": true, - "port": 3000, - "serveDir": "./dist_serve/", - "liveReload": true + "enabled": false }, "watchers": [ { @@ -85,8 +82,7 @@ "name": "website", "from": "./ts_web/index.ts", "to": "./dist_serve/bundle.js", - "watchPatterns": ["./ts_web/**/*"], - "triggerReload": true + "watchPatterns": ["./ts_web/**/*"] } ] } diff --git a/readme.md b/readme.md index f1dabd8..b08e476 100644 --- a/readme.md +++ b/readme.md @@ -130,6 +130,68 @@ volumes: The server listens on port 2999 by default. +## 🛠️ Local Development + +### Prerequisites + +- Node.js 20+ +- pnpm +- MongoDB (local or remote) +- SMTP server (for email verification in registration flow) + +### Getting Started + +```bash +# Clone the repository +git clone https://code.foss.global/idp.global/idp.global.git +cd idp.global + +# Install dependencies +pnpm install + +# Build the project +pnpm build + +# Start development server with hot reload +pnpm watch +``` + +The server runs on **http://localhost:2999** with: +- 🔄 Auto-restart backend on changes (`ts/`) +- 📦 Automatic frontend bundle rebuilding (`ts_web/`) + +### Environment Setup + +Create environment variables for the backend: + +```bash +export MONGODB_URL=mongodb://localhost:27017/idp-dev +export IDP_BASEURL=http://localhost:2999 +export INSTANCE_NAME=idp-dev +``` + +### Development Routes + +| Route | Description | +|-------|-------------| +| `/` | Welcome/landing page | +| `/login` | Sign in form | +| `/register` | New user registration | +| `/account` | User dashboard (requires auth) | + +### 🔑 Default Development Credentials + +For local development with the test database, use: + +| Field | Value | +|-------|-------| +| **Email/Username** | `admin@idp.global` or `admin` | +| **Password** | `admin` | + +This account has `isGlobalAdmin: true` for full platform access including the admin panel at `/account/admin`. + +> ⚠️ **Security Note**: These credentials are for local development only. Never use default credentials in production environments. + ## 📦 Published Packages This monorepo publishes the following npm packages: diff --git a/ts/00_commitinfo_data.ts b/ts/00_commitinfo_data.ts index 299ba5a..28d9c8d 100644 --- a/ts/00_commitinfo_data.ts +++ b/ts/00_commitinfo_data.ts @@ -3,6 +3,6 @@ */ export const commitinfo = { name: '@idp.global/idp.global', - version: '1.15.0', + version: '1.16.0', description: 'An identity provider software managing user authentications, registrations, and sessions.' } diff --git a/ts_web/00_commitinfo_data.ts b/ts_web/00_commitinfo_data.ts index 299ba5a..28d9c8d 100644 --- a/ts_web/00_commitinfo_data.ts +++ b/ts_web/00_commitinfo_data.ts @@ -3,6 +3,6 @@ */ export const commitinfo = { name: '@idp.global/idp.global', - version: '1.15.0', + version: '1.16.0', description: 'An identity provider software managing user authentications, registrations, and sessions.' }