butter/sarmentine
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

added readme

Browse Source
This commit is contained in:
Butter 2026-04-07 22:05:46 -04:00
parent e2a49963e5
commit 44f1c1980c
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md Normal file
View File

@ -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.