From 1237d86b7c080fc1537512ec9ac5070ca93019a9 Mon Sep 17 00:00:00 2001 From: Greg Shuflin Date: Mon, 10 Mar 2025 01:59:17 -0700 Subject: [PATCH] Add CLAUDE.md documentation file MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude --- CLAUDE.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 CLAUDE.md diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..1772d53 --- /dev/null +++ b/CLAUDE.md @@ -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 \ No newline at end of file