Update readme.

This commit is contained in:
2025-11-04 16:41:32 +00:00
parent 97999fa099
commit e098267c81

View File

@@ -1,10 +1,20 @@
# Wild Cloud Development Environment # Wild Cloud Development Environment
## Documentation ## Overview
- [Maintainer Guide](docs/MAINTAINER.md) - Package management and repository deployment This project includes a Claude Code assisted environment for working on all Wild Cloud components at once. Each component of the Wild Cloud project is included as submodules in this repo. This includes:
## Setup - [Wild Central](wild-central/README.md): The network appliance.
- [Wild Centrail API](wild-central-api/README.md): The daemon running on the network appliance.
- [Wild CLI](wild-cli/README.md): A command line interface to the API.
- [Wild Web App](wild-web-app/README.md): A web interface to the API.
- [Wild Directory](wild-directory/README.md): Managed apps to be deployed on wild clouds.
... and, until this milestone is complete:
- [Wild CLoud PoC](wild-cloud-poc/README.md): The proof-of-concept project that includes functional scripts for running a wild cloud within a development environment. This will be retired as soon as the CLI and web-app are at feature-parity.
## Dev environment setup
### Prerequisites ### Prerequisites
@@ -42,3 +52,12 @@ uv sync
# Runtime dependencies # Runtime dependencies
./scripts/install-wild-cloud-dependencies.sh ./scripts/install-wild-cloud-dependencies.sh
```
## Development
You will need to create a data directory and link it in your `.envrc`. The CLI and API will both work against this data dir.
Open the [VSCode workspace](./wild-cloud-dev.code-workspace) in VS Code. Within VS Code, you will be able to launch the API and Web App. The web app will reload as you modify files. The API, however, will need to be rebuilt/reloaded after you make changes.
Both the CLI and the web app use the API as their backend, so any non-CLI/web-app functionality should be in the API. When updating the API, it is important to ensure both the CLI and the web-app work with the updates.