Admin
Getting started
Run the base admin against a running Redelay backend in five minutes.
Getting started
This walkthrough spins up the base admin (admin-core) standalone against a running Redelay backend. For a project-specific admin layered on top, see Building a custom admin project.
Prerequisites
- Node 20+
pnpm10+- A running Redelay admin-api (default
http://localhost:8001). If you don't have one,make infra && make admin-apiin the monorepo'sinfra/dir starts MongoDB + Redis + NATS + the admin-api binary.
1. Clone + install
shell
git clone [email protected]:redelay/js-admin-nuxt4.git
cd js-admin-nuxt4
pnpm install
This clone flow is only for hacking on the base layer itself inside the
monorepo. A real project does not clone the base — it depends on the npm
package
@redelay/js-admin by version (repo redelay/js-admin-nuxt4), with a
gitignored pnpm-workspace.yaml override that links a sibling checkout for
local dev. See Consuming the base layer.2. Point at your backend
Create .env:
ini
NUXT_API_URL=http://localhost:8001
NUXT_STANDALONE=1
NUXT_API_URLis the admin-api host. The dev server proxies/api/v1/**there so the browser sees same-origin requests.NUXT_STANDALONE=1tells the base layer to load its ownassets/css/tailwind.css. Only needed when running the base layer by itself — when it's extended by a project layer, the project brings its own CSS.
3. Run
shell
pnpm dev # http://localhost:3000
You should land on /login. Seed a superuser in the backend if you don't have one yet:
shell
cd ../backend
go run ./cmd/redelayctl create-user [email protected] --password=secret --superuser
Login, and you're in /dashboard.
4. Docker Compose (recommended for local dev)
If you're using the monorepo's infra/docker-compose.yml, both admin containers are pre-wired:
shell
# from monorepo root
make infra # Mongo + Redis + NATS + Kafka + Mailpit
make api # public api
make admin-api # admin api (port 8001)
make admin # admin :3001 + admin-core :3002, both via Docker
make admin brings up both the standalone base (:3002) and the redelay/admin project layer (:3001) in sibling containers, with hot-reload on bind mounts.
5. What's next
- Explore
/flows,/users,/settings,/ai/usage,/system/status. - Add your first project module → see Building admin modules.
- Brand it for your project → see Building a custom admin project.