From 44f1c1980c7a014ecb99e5b439e9072d3de5cf32 Mon Sep 17 00:00:00 2001 From: Butter Date: Tue, 7 Apr 2026 22:05:46 -0400 Subject: [PATCH] added readme --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..fa3b6e2 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# sarmentine + +my current project. it's a web forum thing built with rust. + +right now it's just the skeleton, but the database is hooked up + +### setup +* db is defined in `.env` like so: `DATABASE_URL=sqlite:./YOUR_NAME_HERE.db`. +* it's set to run on `127.0.0.1:3000`. + +### what's inside +* **axum + tokio**: for the server. +* **sqlx + sqlite**: migrations are automated, and i've got WAL mode and foreign keys turned on. +* **askama**: handling the html templates. +* **styling**: vtg fonts and a tiled background. + +### status +* [x] basic routing / main page works +* [x] database connection and migrations. +* [x] basic layout and base templates. +* [ ] auth logic (login/register routes). +* [ ] thread and post functionality. + +it's a start.