agentleFS
Sign inStart free
nexoralnexoral/AxioDB/GUI/AGENTS.md

AxioDB / GUI

AGENTS.md35 starsChanged 9 days agoMITView on GitHub

Global rules live in ../AGENTS.md. This file only adds GUI/ specifics — read the root first. Role — the browser dashboard served by the core's HTTP server on 27018 (and embedded in the Electron app). It is a static React bundle that talks to the HTTP API; it has no server or auth of its own. Its build output (AxioControl/) is copied into lib/server/public by CI — that is what the core serves. React 19 · Vite 6 · Tailwind…

  • Installs packages

The file

We split this AGENTS.md into the rules it gives an agent

1 rule. About 1 is common, 0 are distinctive, and 0 are very specific to this project.

  • ≈1

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Common:

    Keep the bundle dev/local-oriented.

    line 44

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

GUI/ — AxioControl Web Dashboard (Agent Instructions)

Global rules live in ../AGENTS.md. This file only adds GUI/ specifics — read the root first.

Role — the browser dashboard served by the core's HTTP server on 27018 (and embedded in the Electron app). It is a static React bundle that talks to the HTTP API; it has no server or auth of its own. Its build output (AxioControl/) is copied into lib/server/public by CI — that is what the core serves.

Stack

React 19 · Vite 6 · Tailwind CSS v4 (@tailwindcss/vite) · Zustand · React Router 7 · Axios · Recharts · Framer Motion · PWA (vite-plugin-pwa). Code is .jsx in src/ (the README's "TypeScript" wording is stale).

Layout

src/
  api/        HTTP calls (config.jsx, key.js under src/config)
  components/ UI building blocks
  config/     config.jsx, key.js — API base + endpoint keys
  layout/     shell, nav
  pages/      route screens
  store/      Zustand stores
  utils/      shared helpers
  main.jsx    entry · index.css global styles
scripts/optimize-assets.mjs   image pass (sharp)
public/                        static assets

Commands

cd GUI
npm install
npm run dev        # dev server http://localhost:5173
npm run build      # → GUI/AxioControl/ (emptyOutDir)
npm run preview    # serves the production build (port 3000)
npm run lint

Hard rules

  • Dev on 5173, never 27018 — 27018 belongs to the core HTTP server. Point src/config at http://localhost:27018.
  • Talk to the API through src/api + src/config/key.js; never scatter raw endpoint strings through components.
  • Tailwind v4 here (config via @tailwindcss/vite, no tailwind.config.js). Do not copy v3 config style from Document/.
  • build.outDir is AxioControl/ and is gitignored — never commit build output.
  • Keep the bundle dev/local-oriented; no secrets in client code (it is static and public).

Quirks (don't "fix" blindly)

  • vite.config.js carries a stale resolve.alias block (@component → /src/Components, etc.) and a very long assetsInclude list. The real source folders are lowercase (components, pages) — verify an alias resolves before relying on it.
  • server.strictPort: true — if 5173 is taken the dev server fails instead of shifting ports.

Version sync (this folder)

  • GUI/package.json → "version". Keep in lockstep with root (13-place list in root).

Done for this folder

  • npm run dev renders against a running core; npm run build clean
  • npm run lint clean
  • Endpoints come from src/config; no hardcoded URLs in components
  • GUI/package.json version matches root when releasing

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free