feat(dev): add local development docs, update tswatch preset and add Playwright screenshots
This commit is contained in:
@@ -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:
|
||||
|
||||
Reference in New Issue
Block a user