README.md

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.

The folder contents are as follows:

• apps: userland backend and frontend application workspaces
• scripts: deployment, service mocks and documentation scripts
• common: shared JavaScript used by apps / scripts
• docs: for documentation

IMPORTANT! The apps folder is for userland content. E.g workspace codes, documents, scripts, schemas, etc. End-users please work within the apps folder.

Other files and folders are managed by template maintainers.

Quickstart

Getting started with

• Sample API backend apps/sample-api
• Mininal 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.
• Scripts for DB deployments scripts/dbdeploy and Mock serivcesscripts/service-mocks

Creating Own apps/services

• API backend
• Vue frontend
• Publish common/** workspaces to npm. for template maintainers ONLY

Read Me First

• Contributors: read .github/CONTRIBUTING.md and .github/SECURITY.md before opening issues or pull requests. End Users: BEFORE making ANY changes. Read the following:

• SETUP

  • git hooks
  • template updating
  • branching-and-protection
  • commit message lint
  • release automation
  • secret scanning
  • security

• READ

  • Merge strategy
  • Engineering standards format, lint, commit message, language, tooling, etc.
  • Workflows
  • Design Features
  • OPTIONAL: Roadmap
  • OPTIONAL: repo custom properties

CI/CD

• Deploy backend to container registry
• Publish a package to npm
• Deploy frontend (Vue) to object store