Add CLAUDE.md documentation file

🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Greg Shuflin 2025-03-10 01:59:17 -07:00
parent c6b4f4949d
commit 1237d86b7c

23
CLAUDE.md Normal file
View File

@ -0,0 +1,23 @@
# RSS Reader Project Guidelines
## Build & Run Commands
- Run demo mode: `just run-local-demo`
- Run with database: `just run-local-persistant-db`
- Run with Nix: `just run-local-nix`
- Migrations: `just sqlx-prepare`
- Production: `cargo run -- -d database.sqlite -p port`
## Style Guidelines
- **Imports**: Group by source (std lib, external crates, internal modules)
- **Naming**: snake_case for variables/functions, CamelCase for types
- **Documentation**: Use `///` doc comments for public items
- **Error Handling**: Use Result types with detailed error messages
- **Types**: Leverage Rust's type system fully, minimize `unwrap()`
- **Formatting**: Follow standard Rust formatting with 4-space indentation
## Project Architecture
- Web framework: Rocket with SQLite database
- Templates: Tera templates
- Authentication: Argon2/bcrypt password hashing
- Frontend: HTML/CSS with Vite for asset bundling
- Feed handling: RSS/Atom parsing with feed-rs