Vidya is a Learning Management System (LMS) crafted to revolutionize education by enabling you to establish and manage your own schools, complete with students, teachers, and more. It empowers students with the flexibility to learn anytime, anywhere through a state-of-the-art mobile application.
-
🏫 School Management Made Easy Open and manage your own school. Invite students, onboard teachers, and handle everything from one dashboard.
-
📚 Course Creation Build structured courses with lessons and homework. Organize your curriculum exactly the way you want.
-
🌐 Multi-Platform Access Students can join your school via a user-friendly website or mobile app — learning made simple and accessible.
-
🛠️ Your Brand, Your Domain Want a fully branded school on your custom domain? Need a dedicated mobile app? No problem — Vidya generates it for you automatically.
If you'd like to help develop the project, here's a list of links to get you started:
- Development Environment – Configure your development enviroment to get started.
- Good First Issues – a list of simple issues any developer could start from.
- Roadmap - list of tasks we are working on.
modules/
├── libs/ domain, entities, protocol # reusable, no transport or deployment
├── apps/ admin, mobile # user-facing clients
└── services/ api, database, gateway, seeder
Libs never depend on apps or services. Cross-package imports use the @vidya/*
specifiers declared in modules/tsconfig.base.json.
make install # install workspace dependenciesmake check is the gate: typecheck, lint, format-check and test over every
workspace. It is what CI runs, and a branch is not done until it exits 0.
make check # every workspace — required before merging
make check-package PKG=@vidya/api # the same four stages, one workspacecheck-package is the inner loop, not a substitute. A package's own tests say
nothing about the packages that import it, so the full gate still has to run
before the branch is handed over.
Individual stages, workspace-wide:
make typecheck # tsc --noEmit across every workspace
make lint # ESLint (structural limits, purity rules, import order)
make lint-fix # autofix what ESLint can
make format # Prettier
make format-check # Prettier, read-only
make test # every suite, backed by pg-memNarrower:
make test-package PKG=@vidya/api ARGS='--testPathPattern edu'The default suite runs on pg-mem, which is fast but is not Postgres: it has one session and stubs advisory locking out.
make test-postgres-required # only the suites a real database is required for
make test-postgres # every suite, with real Postgres behind ittest-postgres-required runs the *.postgres.spec.ts suites — the ones that
skip themselves under pg-mem and therefore prove nothing there. It is quick and
belongs on every branch that touches the schema or the migration runner.
test-postgres is broader and slower; run it by hand or on a schedule.
Neither falls back to pg-mem when no server is reachable: they stop and say so, because a silent fallback reports a pass for suites that never ran.
Each checkout derives its own test database name, so several worktrees can share
one Postgres server without dropping each other's schema. make db-testdb-drop
reclaims the databases of checkouts that no longer exist.
A fake storage port cannot answer what a provider does: whether a signed
Content-Length is honoured, whether a range request comes back as 206,
whether a POST policy exists at all. Those are the provider's properties, and
every provider answers differently — Bunny has no POST policy and no lifecycle
rules, MinIO has both.
make dev-up # brings up MinIO on 7804 (console 7805, bucket created)
make test-storage-required # only the *.storage.spec.ts suitesLike test-postgres-required, it refuses to report a pass for suites it could
not run — in both directions: no S3 reachable, or no such suites found. The
stand's MinIO doubles as the installation's default storage, so a school that
hands over no credentials of its own writes there (make dev exports the
VIDYA_MEDIA_DEFAULT_* fixtures; see the "Local stand" section of the root
Makefile).
Coverage says a line ran. Mutation testing says the suite would have noticed if the line were wrong.
make mutate-diff PKG=@vidya/api # only the files this branch changed
make mutate-full PKG=@vidya/api # the whole package — hours; run it locallyBoth run incrementally against the baseline committed in .stryker/incremental/,
so a branch is scored against what main produced rather than from zero.
make api-run # start the API in watch mode
make api-test # Jest for the API only
make db-start # start Postgres
make db-migrate # apply migrations
make db-schema-drop # drop the development schema
make db-testdb-drop # drop the databases the test suite created
make seed # populate development dataConventions that coding agents must follow live in AGENTS.md and
.agents/:
.agents/rules/architecture.md— monorepo layout, layering, dependency rules.agents/rules/coding-style-backend.md— NestJS and TypeScript conventions.agents/rules/coding-style-frontend.md— Vue component conventions.agents/rules/comments.md— what a comment may say, and how long it may be.agents/skills/band/SKILL.md— multi-agent TDD orchestrator with automated mutation analysis.agents/pipelines/— tiered quality gate pipeline profiles (hardened, standard, fast, docs).agents/skills/— the coder, makefile, band, and 4-stage review workflows
