Weave Code
Notes Laravel Package
capell-app/notes
A notes package for Capell that lets you create, manage, and display notes within your Laravel application, with a simple admin interface and support for attaching notes to your existing models.
Private, assignable notes and @mentions for any Capell admin record
Frequently asked questions about Notes
- How do I install capell-app/notes in a Laravel application?
- Install the package with Composer inside a Capell-powered Laravel application, then publish its migrations and configuration and run the migrations. Service provider discovery registers the module automatically in a standard Capell setup. Because the package is currently published as a beta, pin the exact version in composer.json rather than using a floating constraint.
- Does capell-app/notes work in a plain Laravel app without Capell?
- No. capell-app/notes is a module in the Capell CMS family and expects Capell core and its conventions to be present. If your application is not already running Capell, installing this package pulls the whole ecosystem in with it. For a standalone notes feature outside Capell, a generic polymorphic notes package or a small custom morphMany table is the simpler route.
- How do I attach a note to an existing Eloquent model such as a user or order?
- Notes are attached through polymorphic relationships, so any Eloquent model can own notes without duplicating schema. You define the relationship on your model and then create or query notes through the package's Eloquent-friendly API. This works for pages, users, orders, and custom entities alike.
- Does capell-app/notes support multilingual note content?
- Yes. Note content is translated through Capell's translation layer, so notes can hold per-locale values rather than a single string. This depends on the translation setup in your Capell core installation being configured for the locales you need. If you only need single-language notes, the translation layer is simply unused.
- How do I publish the migrations and config for capell-app/notes?
- The package ships publishable migrations and configuration out of the box, typically published with Laravel's vendor:publish command. Before committing, confirm whether migrations are auto-loaded by the package or owned by your application after publishing. Run them against a production-shaped copy of your data so you can capture and review the resulting schema.
- Which PHP and Laravel versions does capell-app/notes support?
- The supported matrix is defined by the php and illuminate/* constraints in the package's composer.json, together with its constraint on capell-app/core. These are not confirmed for the current beta release, so check them against your host application first. A mismatch here is the cheapest blocker to find and the most common one.
- Is capell-app/notes stable enough for production use?
- The current release is 1.1.0-beta.47, meaning 47 beta iterations on a single minor line, which signals a public surface that is still moving. The release notes contain only an auto-generated compare link, with no changelog, migration notes, or breaking-change flag. Unless you have a hard deadline, integrate only after a tagged stable release; otherwise spike in a throwaway branch and feature-flag the integration behind an abstraction boundary.
- How do I query and render notes for a model efficiently?
- Use the polymorphic relationship the package exposes and eager load it with with('notes') to avoid N+1 queries when listing many models. Notes can be filtered and rendered in your own views or through Capell's admin UI integration for creating and editing them. At volume, check that the polymorphic columns are indexed on your database.
- How do I test note attachments in my Laravel test suite?
- Run your normal test suite against the published migrations using RefreshDatabase, then create notes through the relationship in your arrange step and assert the morphMany result. The package documentation does not advertise dedicated test helpers or factories, so treat note creation as part of your own fixtures. If you keep the notes data model behind an application-level repository interface, you can swap implementations in tests without rewriting callers.
- What changed between capell-app/notes beta.46 and beta.47, and is there a changelog?
- There is no changelog: the beta.47 release notes contain only a GitHub auto-generated compare link, so schema, contract, and config changes cannot be determined from the release itself. As a substitute, install beta.45, beta.46, and beta.47 into separate branches and diff composer.json, composer.lock, and the migrated schema. That empirical diff is also the fastest way to see whether migrations are additive and whether rollback is safe.
Weaver
How can I help you explore Laravel packages today?