Clinimatix Caravel documentation
New here? Start with the repository README and its quick start.
The basics
- Getting started: how a Caravel app starts up, and what it sets up for you
- Configuration: settings files,
.envand environment variables - Development sessions: watch your web app and run a worker with one command
- Hosting: run web apps and workers as services, containers or IIS sites
Data
- Clarion: query and save models, soft deletes, factories and seeders
- Bosun data commands: generate models and run migrations and seeders
- Database providers: which databases you can use today
Authentication
- Local accounts: ASP.NET Core Identity with secure defaults
- Sign in with an identity provider: OpenID Connect for browser sign-in
- Service authentication: protect APIs with bearer access tokens
- Windows authentication: intranet sign-in with organizational accounts
Application services
- Events: notify other parts of your app
- Queues: durable background jobs that survive restarts
- Mail: transactional email, templates, attachments and queued sending
- Notifications: replaceable mail and SMS delivery channels
- Scheduling: enqueue recurring work at fixed intervals
- Bosun service generators: generate jobs, events and listeners
- Local storage: stream files into named storage disks
- Caching: use .NET's memory and SQL Server caches
- Observability: queue metrics, tracing and health checks
Putting it together
- Backend sample: sign-in, durable ingestion and reporting working together
About the project
- Design and roadmap: principles, package layout, current status and what's next
- Versions and releases: what milestone, release candidate and stable mean
- Testing Caravel: build, test and verify changes as a contributor
- Changelog
- Contributing and security