mirror of
https://github.com/bretzel-app/crumbs.git
synced 2026-10-12 20:06:57 +02:00
Frederic CabassutandClaude Opus 4.6
6d503bbc8c
- Add SMTP configuration example to README install section - Add note version history, sharing, and email notifications to README feature list - Expand FEATURES.md with all 9 email notification types and version history section - Add note sharing, version history, and email alerts feature cards to landing page - Add all OAuth/SSO env vars to docker-compose.yml with empty defaults Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
141 lines
4.4 KiB
Markdown
141 lines
4.4 KiB
Markdown
[](https://github.com/bretzel-app/crumbs/actions/workflows/ci.yml)
|
|
[](LICENSE)
|
|
[](https://github.com/bretzel-app/crumbs/releases)
|
|
[](https://github.com/bretzel-app/crumbs/pkgs/container/crumbs)
|
|
|
|
<p align="center">
|
|
<img src="static/favicon-96x96.png" alt="Crumbs logo" width="96" height="96">
|
|
</p>
|
|
|
|
# Crumbs by Bretzel
|
|
|
|
A self-hostable, offline-first note-taking app that respects your privacy. Part of the [Bretzel](https://bretzel.app) app universe.
|
|
|
|
## Install
|
|
|
|
### Docker (Recommended)
|
|
|
|
```bash
|
|
docker compose up -d
|
|
```
|
|
|
|
Open http://localhost:3000 and create your admin account on first visit.
|
|
|
|
#### With SSO (optional)
|
|
|
|
```yaml
|
|
# docker-compose.yml
|
|
services:
|
|
crumbs:
|
|
image: ghcr.io/bretzel-app/crumbs:latest
|
|
ports:
|
|
- "3000:3000"
|
|
volumes:
|
|
- crumbs-data:/data
|
|
environment:
|
|
- ORIGIN=https://notes.example.com
|
|
- AUTH_OIDC_ISSUER=https://authentik.example.com/application/o/crumbs/
|
|
- AUTH_OIDC_CLIENT_ID=your-client-id
|
|
- AUTH_OIDC_CLIENT_SECRET=your-client-secret
|
|
- AUTH_OIDC_DISPLAY_NAME=Authentik
|
|
restart: unless-stopped
|
|
|
|
volumes:
|
|
crumbs-data:
|
|
```
|
|
|
|
Google and GitHub OAuth are also supported. See [docs/AUTH.md](docs/AUTH.md) for all providers and setup guides.
|
|
|
|
#### With Email Notifications (optional)
|
|
|
|
Add SMTP settings to enable email notifications (share alerts, welcome emails, security alerts):
|
|
|
|
```yaml
|
|
environment:
|
|
- SMTP_HOST=smtp.example.com
|
|
- SMTP_PORT=587
|
|
- SMTP_USER=your-username
|
|
- SMTP_PASS=your-password
|
|
- SMTP_FROM=Crumbs <noreply@example.com>
|
|
```
|
|
|
|
Auto-enabled when `SMTP_HOST` is set. Users can opt out in Settings > Preferences. See [docs/DEPLOYMENT.md](docs/DEPLOYMENT.md#email-notifications-optional) for details.
|
|
|
|
### Manual (Node.js)
|
|
|
|
```bash
|
|
git clone <repo-url> crumbs && cd crumbs
|
|
pnpm install
|
|
pnpm build
|
|
DATABASE_URL=./data/crumbs.db ORIGIN=http://localhost:3000 node build
|
|
```
|
|
|
|
### Development
|
|
|
|
```bash
|
|
pnpm install
|
|
pnpm dev
|
|
```
|
|
|
|
Run `make help` to see all available commands, or use pnpm directly:
|
|
|
|
```bash
|
|
pnpm test # Unit + E2E tests
|
|
pnpm check # Type checking
|
|
pnpm build # Production build
|
|
```
|
|
|
|
## Features
|
|
|
|
- Rich notes with Markdown, checklists, image attachments, and 12 color themes
|
|
- Organize with #tags, pinning, archive, and trash
|
|
- Full-text search across titles, content, and tags
|
|
- Note version history — browse and restore previous versions
|
|
- Share notes with other users on the same instance
|
|
- Email notifications for shares, security alerts, and account events (optional SMTP)
|
|
- PWA — installable, works offline via IndexedDB + LWW CRDT sync
|
|
- MCP server — let AI assistants (Claude Code, etc.) manage your notes
|
|
- Multi-user auth (Argon2) with optional OAuth/SSO (Google, GitHub, OIDC)
|
|
- Docker deployment with a single command
|
|
|
|
See [docs/FEATURES.md](docs/FEATURES.md) for detailed feature documentation.
|
|
|
|
## Tech Stack
|
|
|
|
| Layer | Technology |
|
|
|-------|-----------|
|
|
| Framework | SvelteKit 2 (Svelte 5 runes) |
|
|
| Language | TypeScript (strict) |
|
|
| UI | Tailwind CSS 4 |
|
|
| Database | SQLite (better-sqlite3) + Drizzle ORM |
|
|
| Client DB | IndexedDB (idb) |
|
|
| Sync | LWW CRDTs |
|
|
| Auth | Argon2 + session cookies |
|
|
| Testing | Vitest + Playwright |
|
|
| Container | Docker (multi-stage) |
|
|
| CI/CD | GitHub Actions |
|
|
|
|
## Documentation
|
|
|
|
| Document | Description |
|
|
|----------|-------------|
|
|
| [Features](docs/FEATURES.md) | Detailed feature list and behavior |
|
|
| [Architecture](docs/ARCHITECTURE.md) | Local-first sync design, tech rationale, DB schema |
|
|
| [Auth](docs/AUTH.md) | Password auth, OAuth/SSO setup (Authentik, Keycloak, etc.) |
|
|
| [Deployment](docs/DEPLOYMENT.md) | Docker, Node.js, reverse proxy, backups, env vars |
|
|
| [API](docs/API.md) | REST API reference (auto-generated) |
|
|
| [Contributing](CONTRIBUTING.md) | How to contribute |
|
|
| [Security](SECURITY.md) | Vulnerability reporting policy |
|
|
| [Changelog](CHANGELOG.md) | Release history |
|
|
|
|
## CI/CD
|
|
|
|
- **CI** — lint, type check, unit tests, E2E tests, Docker build on every push/PR
|
|
- **Release** — builds and pushes Docker image on `v*` tags
|
|
|
|
Configure registry via GitHub Secrets: `REGISTRY_URL`, `REGISTRY_USER`, `REGISTRY_TOKEN`.
|
|
|
|
## License
|
|
|
|
[MIT](LICENSE)
|