mirror of
https://github.com/zitadel/zitadel.git
synced 2025-08-11 13:19:21 +00:00
turbo for console
This commit is contained in:
@@ -1,27 +1,126 @@
|
||||
# Console
|
||||
# Console Angular App
|
||||
|
||||
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 8.3.20.
|
||||
This is the ZITADEL Console Angular application.
|
||||
|
||||
## Development server
|
||||
## Development
|
||||
|
||||
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
|
||||
### Prerequisites
|
||||
|
||||
## Code scaffolding
|
||||
- Node.js 18 or later
|
||||
- pnpm (latest)
|
||||
|
||||
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
|
||||
### Installation
|
||||
|
||||
## Build
|
||||
```bash
|
||||
pnpm install
|
||||
```
|
||||
|
||||
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
|
||||
### Proto Generation
|
||||
|
||||
## Running unit tests
|
||||
The Console app uses **dual proto generation** with Turbo dependency management:
|
||||
|
||||
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
|
||||
1. **`@zitadel/proto` generation**: Modern ES modules with `@bufbuild/protobuf` for v2 APIs
|
||||
2. **Local `buf.gen.yaml` generation**: Traditional protobuf JavaScript classes for v1 APIs
|
||||
|
||||
## Running end-to-end tests
|
||||
The Console app's `turbo.json` ensures that `@zitadel/proto#generate` runs before the Console's own generation, providing both:
|
||||
|
||||
Please refer to the [contributing guide](../CONTRIBUTING.md#console)
|
||||
- Modern schemas from `@zitadel/proto` (e.g., `UserSchema`, `DetailsSchema`)
|
||||
- Legacy classes from `src/app/proto/generated` (e.g., `User`, `Project`)
|
||||
|
||||
## Further help
|
||||
Generated files:
|
||||
|
||||
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
|
||||
- **`@zitadel/proto`**: Modern ES modules in `login/packages/zitadel-proto/`
|
||||
- **Local generation**: Traditional protobuf files in `src/app/proto/generated/`
|
||||
- TypeScript definition files (`.d.ts`)
|
||||
- JavaScript files (`.js`)
|
||||
- gRPC client files (`*ServiceClientPb.ts`)
|
||||
- OpenAPI/Swagger JSON files (`.swagger.json`)
|
||||
|
||||
To generate proto files:
|
||||
|
||||
```bash
|
||||
pnpm run generate
|
||||
```
|
||||
|
||||
This automatically runs both generations in the correct order via Turbo dependencies.
|
||||
|
||||
### Development Server
|
||||
|
||||
To start the development server:
|
||||
|
||||
```bash
|
||||
pnpm start
|
||||
```
|
||||
|
||||
This will:
|
||||
|
||||
1. Fetch the environment configuration from the server
|
||||
2. Serve the app on the default port
|
||||
|
||||
### Building
|
||||
|
||||
To build for production:
|
||||
|
||||
```bash
|
||||
pnpm run build
|
||||
```
|
||||
|
||||
This will:
|
||||
|
||||
1. Generate proto files (via `prebuild` script)
|
||||
2. Build the Angular app with production optimizations
|
||||
|
||||
### Linting
|
||||
|
||||
To run linting and formatting checks:
|
||||
|
||||
```bash
|
||||
pnpm run lint
|
||||
```
|
||||
|
||||
To auto-fix formatting issues:
|
||||
|
||||
```bash
|
||||
pnpm run lint:fix
|
||||
```
|
||||
|
||||
## Project Structure
|
||||
|
||||
- `src/app/proto/generated/` - Generated proto files (Angular-specific format)
|
||||
- `buf.gen.yaml` - Local proto generation configuration
|
||||
- `turbo.json` - Turbo dependency configuration for proto generation
|
||||
- `prebuild.development.js` - Development environment configuration script
|
||||
|
||||
## Proto Generation Details
|
||||
|
||||
The Console app uses **dual proto generation** managed by Turbo dependencies:
|
||||
|
||||
### Legacy v1 API (Traditional Protobuf)
|
||||
|
||||
- Uses local `buf.gen.yaml` configuration
|
||||
- Generates traditional Google protobuf JavaScript classes extending `jspb.Message`
|
||||
- Uses plugins: `protocolbuffers/js`, `grpc/web`, `grpc-ecosystem/openapiv2`
|
||||
- Output: `src/app/proto/generated/`
|
||||
- Used for: Most existing Console functionality
|
||||
|
||||
### Modern v2 API (ES Modules)
|
||||
|
||||
- Uses `@zitadel/proto` package generation
|
||||
- Generates modern ES modules with `@bufbuild/protobuf`
|
||||
- Uses plugin: `@bufbuild/es` with ES modules and JSON types
|
||||
- Output: `login/packages/zitadel-proto/`
|
||||
- Used for: New user v2 API and services
|
||||
|
||||
### Dependency Management
|
||||
|
||||
The Console's `turbo.json` ensures proper execution order:
|
||||
|
||||
1. `@zitadel/proto#generate` runs first (modern ES modules)
|
||||
2. Console's local generation runs second (traditional protobuf)
|
||||
3. Build/lint/start tasks depend on both generations being complete
|
||||
|
||||
This approach allows the Console app to use both v1 and v2 APIs while maintaining proper build dependencies.
|
||||
|
||||
## Legacy Information
|
||||
|
||||
This project was originally generated with Angular CLI version 8.3.20 and has been updated over time.
|
||||
|
@@ -4,11 +4,12 @@
|
||||
"scripts": {
|
||||
"ng": "ng",
|
||||
"start": "node prebuild.development.js && ng serve",
|
||||
"prebuild": "pnpm run generate",
|
||||
"build": "ng build --configuration production --base-href=/ui/console/",
|
||||
"prelint": "pnpm run generate",
|
||||
"lint": "ng lint && prettier --check src",
|
||||
"lint:fix": "prettier --write src",
|
||||
"generate": "buf generate ../proto --include-imports --include-wkt"
|
||||
"generate": "pnpm exec buf generate ../proto --include-imports --include-wkt"
|
||||
},
|
||||
"private": true,
|
||||
"dependencies": {
|
||||
|
23
console/turbo.json
Normal file
23
console/turbo.json
Normal file
@@ -0,0 +1,23 @@
|
||||
{
|
||||
"$schema": "https://turbo.build/schema.json",
|
||||
"extends": ["//"],
|
||||
"tasks": {
|
||||
"generate": {
|
||||
"dependsOn": ["@zitadel/proto#generate"],
|
||||
"outputs": ["src/app/proto/generated/**"]
|
||||
},
|
||||
"build": {
|
||||
"dependsOn": ["generate"],
|
||||
"outputs": ["dist/**"]
|
||||
},
|
||||
"start": {
|
||||
"dependsOn": ["generate"],
|
||||
"cache": false,
|
||||
"persistent": true
|
||||
},
|
||||
"lint": {
|
||||
"dependsOn": ["generate"],
|
||||
"outputs": []
|
||||
}
|
||||
}
|
||||
}
|
@@ -42,8 +42,6 @@
|
||||
"@eslint/compat": "^1.3.1",
|
||||
"@eslint/eslintrc": "^3.3.1",
|
||||
"@vitejs/plugin-react": "^4.4.1",
|
||||
"@zitadel/eslint-config": "workspace:*",
|
||||
"@zitadel/prettier-config": "workspace:*",
|
||||
"axios": "^1.8.4",
|
||||
"dotenv": "^16.5.0",
|
||||
"dotenv-cli": "^8.0.0",
|
||||
|
1241
pnpm-lock.yaml
generated
1241
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user