Skip to content
/docs/development

Developers

Run the repo

Clone, install, develop and test — the commands package.json actually defines.

git clone https://github.com/Abdodiab2005/levix.gitcd levixnpm installnpm run dev

npm run dev restarts on file changes (nodemon). npm start runs it plainly. Either way the panel comes up on port 3001 and the first-run screen asks for the panel password, exactly like an installed build. Node 24+ is required — everything, including the database driver, assumes it.

The scripts

ScriptWhat it does
npm run dev / npm startRun the bot from source (nodemon / plain).
npm testRun tests/*.test.mjs — each file gets its own fresh process and a temporary data directory.
npm run lint / npm run format / npm run checkBiome lint, format, and the combined check. check:fix writes fixes.
npm run build:frontendBuild the panel's React app into public/dashboard.* — the bot serves whatever is there.
npm run build (or npm pack)Prepares a release: prepack builds the frontend first.
npm run build:seaBuild the single-file executable (Node SEA + postject).
npm run validate:*Post-build sanity checks: tarball, SEA binary, Docker image.

Docker isn't a separate code path — the image runs the same start command against the same source tree, and validate:docker builds the image to prove it. For deployment tooling see the VPS and Docker documentation pages.