Sitelet https://github.com/upMVC/upMVC-SaaS/tree/master/docs
Skip to content

Latest commit

 

History

History

README.md

upMVC-SaaS Starter Documentation

upMVC-SaaS is now the composed starter application:

upMVC-SaaS = upMVC kernel + upMVC-SaaS-Pack + app config

This documentation covers the starter app and the SaaS product flow. Framework internals live in upMVC. Reusable SaaS modules live in upMVC-SaaS-Pack.

Documentation Index

Doc What It Covers
01 — What is upMVC-SaaS The starter concept and SaaS goal
02 — Architecture Composer packages, request flow, module loading
03 — Getting Started Install, configure, import demo data, run
04 — API Modules SaaS pack API module conventions
05 — Auth & JWT Login, refresh tokens, JWT context
06 — Tenants & Plans Tenants, plans, feature gating
07 — Platform Admin Admin shell, impersonation, tenant control
08 — Your Way How to customize or override pack behavior

Quick Orientation

public/index.php          app entry point
src/Etc/.env.example      app environment template
src/Etc/packages.php      enables the SaaS pack
database/demo.sql         demo schema and data
vendor/bitshost/upmvc     framework/runtime
vendor/bitshost/upmvc-saas-pack
  src/Modules/*           SaaS modules

Add local overrides in src/Modules only when you need to replace or extend a pack module.