chore: updated docs
cc49c8ee
2 file(s) · +14 −1
| 22 | 22 | | Crate | Description | |
|
| 23 | 23 | |---|---| |
|
| 24 | 24 | | [`andromeda-auth`](crates/auth) | Session-based password authentication | |
|
| 25 | + | | [`andromeda-db`](crates/db) | Shared database types and session management | |
|
| 25 | 26 | ||
| 26 | 27 | ## Stack |
|
| 27 | 28 |
| 39 | 39 | ||
| 40 | 40 | [Tokio](https://tokio.rs) provides the async runtime that Axum runs on. |
|
| 41 | 41 | ||
| 42 | - | ## Shared Crate: andromeda-auth |
|
| 42 | + | ## Shared Crates |
|
| 43 | + | ||
| 44 | + | ### andromeda-auth |
|
| 43 | 45 | ||
| 44 | 46 | The `andromeda-auth` crate provides session-based password authentication used across apps that require login. It handles: |
|
| 45 | 47 | ||
| 46 | 48 | - Constant-time password verification |
|
| 47 | 49 | - Session cookie management |
|
| 48 | 50 | - Secure cookie configuration via `COOKIE_SECURE` env var |
|
| 51 | + | ||
| 52 | + | ### andromeda-db |
|
| 53 | + | ||
| 54 | + | The `andromeda-db` crate provides shared database types and utilities used across apps. It handles: |
|
| 55 | + | ||
| 56 | + | - `Db` type alias (`Arc<Mutex<Connection>>`) for thread-safe SQLite access |
|
| 57 | + | - `HasDb` trait for consistent database access across app states |
|
| 58 | + | - `DbError` type with automatic conversion from rusqlite errors |
|
| 59 | + | - Optional Axum integration (`axum` feature) for `IntoResponse` on errors |
|
| 60 | + | - Optional session management (`session` feature) |
|
| 49 | 61 | ||
| 50 | 62 | ## App Pattern |
|
| 51 | 63 |