Skip to content

Commit 019a0e5

Browse files
committed
Update readme
1 parent d135c5c commit 019a0e5

1 file changed

Lines changed: 50 additions & 10 deletions

File tree

README.md

Lines changed: 50 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,59 @@
1-
# App
1+
# OpenWorkers Dashboard
22

3-
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 14.2.6.
3+
Web UI for managing OpenWorkers — create, edit, and deploy workers from your browser.
44

5-
## Development server
5+
## Features
66

7-
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files.
7+
- **Code Editor** — Monaco Editor with TypeScript support
8+
- **Live Logs** — Real-time log streaming via SSE
9+
- **Cron Triggers** — Visual cron expression builder with [croner-wasm](https://github.com/openworkers/croner-wasm)
10+
- **Environment Variables** — Manage secrets and configuration
11+
- **Bindings** — Configure KV, Storage, and Database bindings
812

9-
## Code scaffolding
13+
## Stack
1014

11-
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`.
15+
- **Angular 21** — Standalone components, signals
16+
- **Tailwind CSS 4** — Utility-first styling
17+
- **Monaco Editor** — VS Code's editor component
18+
- **Heroicons** — Icon set
1219

13-
## Build
20+
## Development
1421

15-
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.
22+
```bash
23+
# Install dependencies
24+
bun install
1625

17-
## Further help
26+
# Start dev server (http://localhost:4200)
27+
bun run dev
1828

19-
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
29+
# Build for production
30+
bun run build
31+
```
32+
33+
## Project Structure
34+
35+
```
36+
src/app/
37+
├── modules/ # Feature modules (workers, environments, etc.)
38+
├── services/ # API clients, auth, state
39+
├── shared/ # Shared components
40+
├── guards/ # Route guards
41+
├── interceptors/ # HTTP interceptors
42+
└── interfaces/ # TypeScript interfaces
43+
```
44+
45+
## Configuration
46+
47+
The dashboard connects to the OpenWorkers API. Configure the API URL in `src/environments/`:
48+
49+
```typescript
50+
export const environment = {
51+
apiUrl: 'https://api.workers.rocks'
52+
};
53+
```
54+
55+
## Related
56+
57+
- [openworkers-api](https://github.com/openworkers/openworkers-api) — REST API
58+
- [openworkers-runner](https://github.com/openworkers/openworkers-runner) — Worker runtime
59+
- [openworkers-infra](https://github.com/openworkers/openworkers-infra) — Docker Compose setup

0 commit comments

Comments
 (0)