unrip/README.md

66 lines
1.6 KiB
Markdown

# unrip project
This directory contains the trading-system project code and project-specific deployment assets.
It is shaped so it can later become its own repository with minimal reshuffling.
## Contents
- `src/` — application code
- `package.json` / `package-lock.json` — Node package manifest
- `Dockerfile` / `.dockerignore` — app container build
- `.env.example` — local app runtime example
- `compose.yml` — local development stack
- `deploy/k8s/base/` — project-specific Kubernetes manifests
- `deploy/redpanda/rpk-topics.txt` — project topic reference
- `docs/` — project-specific design and contract docs
## Local development
```bash
cd projects/unrip
npm install
cp .env.example .env
# edit .env
docker compose up -d --build
```
Useful commands:
```bash
docker compose ps
docker compose logs -f
docker compose logs -f near-intents-ingest dummy-reactor dummy-executor dummy-consumer
npm run near-intents:ingest
npm run dummy-reactor
npm run dummy-executor
npm run dummy-consumer
```
## App image
The app image is now built from this directory.
Examples:
```bash
cd projects/unrip
docker build -t unrip:dev .
```
## Kubernetes manifests
Project manifests live under:
- `projects/unrip/deploy/k8s/base/`
They are consumed by the shared Hetzner overlay and bootstrap flow from the repo root.
The shared platform remains outside this directory.
## Shared platform docs
For cluster/platform/bootstrap details, see the repo-root docs:
- `docs/hetzner-k3s-bootstrap.md`
- `docs/hetzner-self-hosted-ci-runbook.md`
- `docs/k8s-observability.md`
- `deploy/k8s/README.md`