73 lines
2.4 KiB
Markdown
73 lines
2.4 KiB
Markdown
# EDP - Edge Developer Platform
|
|
|
|
Documentation for the edgeDeveloperFramework (eDF) project and the resulting Edge Developer Platform (EDP) product suite.
|
|
|
|
## Quick Start
|
|
|
|
### Development Environment
|
|
|
|
Install and enter [Devbox](https://www.jetify.com/devbox):
|
|
```bash
|
|
curl -fsSL https://get.jetify.com/devbox | bash
|
|
devbox shell
|
|
```
|
|
|
|
Devbox installs Hugo, Node.js, Go, and all required tools. First-time setup requires sudo for the Nix daemon (one-time only).
|
|
|
|
To avoid entering the shell, run commands directly:
|
|
```bash
|
|
devbox run task serve
|
|
```
|
|
|
|
### Local Development
|
|
|
|
```bash
|
|
task deps:install # Install dependencies
|
|
task serve # Start dev server at http://localhost:1313 (hot-reloading)
|
|
task test:quick # Run tests
|
|
task build # Build production site
|
|
```
|
|
|
|
## Architecture Diagrams (LikeC4)
|
|
|
|
[LikeC4](https://likec4.dev/) generates interactive architecture diagrams from text-based [C4 models](https://c4model.com/). Create or edit diagrams:
|
|
|
|
```bash
|
|
cd resources/edp-likec4 # Platform architecture
|
|
npm install # First time only
|
|
npm start # Preview at http://localhost:5173
|
|
```
|
|
|
|
Edit `.c4` files to define systems and views. Generate web components for Hugo:
|
|
```bash
|
|
task likec4:generate
|
|
```
|
|
|
|
Embed in Markdown pages:
|
|
```markdown
|
|
{{</* likec4-view view="overview" project="architecture" */>}}
|
|
```
|
|
|
|
See [LikeC4 documentation](https://likec4.dev/) for detailed syntax and [README-likec4.md](doc/README-likec4.md) for project-specific details.
|
|
|
|
## Deployment
|
|
|
|
Deployment is automatic via ArgoCD. Push to `main` triggers CI/CD build and deployment within 5-10 minutes.
|
|
|
|
**Infrastructure Configuration:**
|
|
- ArgoCD is configured within [stacks-instances](https://edp.buildth.ing/DevFW-CICD/stacks-instances/src/branch/main/otc/edp.buildth.ing/registry/docs.yaml)
|
|
- Documentation stack definition: [./argocd-stack/](https://edp.buildth.ing/DevFW-CICD/website-and-documentation/src/branch/main/argocd-stack)
|
|
|
|
## Documentation
|
|
|
|
* [Developer Guide](doc/README-developer.md)
|
|
* [Technical Writer Guide](doc/README-technical-writer.md)
|
|
* [Release Notes](doc/RELEASE.md)
|
|
|
|
## Project
|
|
|
|
This is a Hugo-based documentation site for the Edge Developer Platform, built as part of the IPCEI-CIS project.
|
|
|
|
**Website:** Access the documentation at the deployed URL or run locally with `task serve`
|
|
|
|
For detailed information, see the documentation in the `doc/` folder.
|