Description

novex-kit is a monorepo template for building full-stack JavaScript applications, micro-services and frontends with NodeJS (version 24 or Higher). VueJS and ExpressJS are highlighted but end-user is free to implement their own JS/TS stack.

Important Information

For End-user

• This is a template repo. Do NOT use directly. Create End-user repo based on novex-kit template
• ONLY make modifications to the following in their own repository.
  • anything in side the following folders
    • apps: workspace codes, documents, scripts, etc.
    • db: database schemas, migrations and seeds, etc. (one workspace per PostgreSQL schema)
  • the following files at repo root
    • replaced on every template sync — re-apply your changes after each sync
    • package.json
    • package-lock.json
  • local- prefixed files in .github/workflows folder
  • local- prefixed folders in .github/actions folder
• NEVER!!! touch anything else. If you need to override or create features
  • do it in the apps folder if urgent
  • raise an issue or submit a PR contribution
• End-users can pull in template updates using the Sync Upstream Template workflow

For Contributor (or Maintainer)

• fork/clone the repo to improve/maintain the framework
• For Contributors, read .github/CONTRIBUTING.md and .github/SECURITY.md before opening issues or pull requests.

Folder Layout

Full folder layout — every app, package and schema: docs/structure.md.

Instructions

Both End-user and Contributor must read and follow the documentation below.

• Install packages from root level only, if it is used by workspace, name the workspace
• git related
  • Setup hooks
  • Read on branch naming and workflows
  • Read on commit messaging
  • Read on Pull Requests
• github related Setup your downstream repository
  • rulesets
  • environment
  • Advanced Security
  • CI
  • The full workflow list.
  • Release Management
• READ
  • Design Features
  • Engineering standards format, lint, commit message, language, tooling, etc.
  • Housekeeping dependency and GitHub Actions updates — Dependabot plus on-demand Claude Code commands
  • Testing
  • OPTIONAL: Roadmap
  • OPTIONAL: repo custom properties

Quickstart

npm run clean:all
npm install
cd apps/sample-api
npm run start
curl http://127.0.0.1/health
curl http://127.0.0.1/health/live

Getting started with

• Sample API backend apps/sample-api
• Minimal Vue frontend apps/sample-vue-minimal
• Sample Vue frontend apps/sample-vue-full
• Shared codes common/ ESM modules for Node, browser, Vue, and isomorphic code
  • sample implementations for SAML, OIDC, OAuth, OTP, FIDO2, and push notifications, zod, OpenAPI, etc.
• Database schemas, migrations, and seeds db and mock services scripts/service-mocks

Creating Own apps/services

• API backend — create:app CLI or copy sample-api
• Vue frontend
• Publish common/** workspaces to npm. for template maintainers ONLY