Documentation
Shamar is an admin panel for AdonisJS. You describe resources in TypeScript. The panel serves the lists, forms, and navigation. Start with Introduction if you have not seen how those pieces fit. It explains the host, the database adapters, and what you still own before any install command.
Start here
Section titled “Start here”| If you want to… | Read |
|---|---|
| Understand the product before installing | Introduction |
| Add it to an Adonis app | Installation |
| Get one CRUD screen working | Your first resource |
| Click a seeded panel | Live demo |
| Use MongoDB, SQL, permissions, or a JSON API | Packages |
pnpm add @shamar/adonisnode ace configure @shamar/adonisThe panel, section by section
Section titled “The panel, section by section”Each section below starts by explaining what the feature is. The pages inside it are the reference: method names, options, and examples.
| Section | What it is |
|---|---|
| Resources | One model, exposed as list, create, edit, and show |
| Forms | The inputs on create and edit |
| Tables | The columns, search, and filters on a list |
| Infolists | The read-only view of one record |
| Widgets | The cards and charts on a dashboard |
| Actions | Buttons that do something to a record or a selection |
| Pages | Screens that are not a resource, such as settings |
| Wire | Live components whose state lives on the server |
| Auth & RBAC | Sign-in, then permissions |
| Media library | Files, folders, and file fields |