25 lines
2.0 KiB
Markdown
25 lines
2.0 KiB
Markdown
# CRUX Documentation
|
|
|
|
Documentation home for the CRUX monorepo. See also [Architecture](./architecture/Readme.md), [Packages](./packages/Readme.md). App docs live with each app: [admin UI style guide](../apps/admin/ui-style-guide.md), [web](../apps/web/Readme.md).
|
|
|
|
## Core Modules
|
|
|
|
| Module | Backend | Frontend | Documentation |
|
|
| ---------------- | -------------------------------------------- | -------------------------------------- | --------------------------------------------- |
|
|
| Access Control | Admin, Role, Permission base modules | `apps/admin/src/core/AccessControl/` | [Overview](./core/access-control/Readme.md) |
|
|
| Account Settings | Admin profile endpoints | `apps/admin/src/core/AccountSettings/` | [Overview](./core/account-settings/Readme.md) |
|
|
| Auth | `apps/backend/app/base_modules/Auth/` | `apps/admin/src/core/Auth/` | [Overview](./core/auth/Readme.md) |
|
|
| Devtools | Dev-only | `apps/admin/src/devtools/` | [Overview](./core/devtools/Readme.md) |
|
|
| Fallback Screens | Frontend-only | `apps/admin/src/core/FallbackScreens/` | [Overview](./core/fallback-screens/Readme.md) |
|
|
| File Manager | `apps/backend/app/base_modules/FileManager/` | `apps/admin/src/core/FileManager/` | [Overview](./core/file-manager/Readme.md) |
|
|
| Permission | Permission service and policies | `apps/admin/src/core/Permission/` | [Overview](./core/permission/Readme.md) |
|
|
| Web Manager | `apps/backend/app/base_modules/WebManager/` | `apps/admin/src/core/WebStudio/` | [Overview](./core/web-manager/Readme.md) |
|
|
|
|
## Project Modules
|
|
|
|
Project-specific modules: [docs/modules/](./modules/Readme.md).
|
|
|
|
## Shared Packages
|
|
|
|
Package docs live with the package source; see the [Packages index](./packages/Readme.md).
|