First version

README.md

@@ -0,0 +1,16 @@
+# CalFlow
+A simple calorie tracking app
+
+## Development Setup
+### DB
+Start the corresponding docker-compose file to run a temporary postgres instance.
+
+To inspect the DB state directly `docker compose exec pg psql -U postgres test`
+
+### Backend
+Go into the backend folder and run it using `cargo run`
+
+### Frontend
+1. Start a node environment using docker (`docker run -it -v $(pwd):/mnt/calflow --net=host node:25 /bin/bash`)
+2. Go into the frontend folder (`cd /mnt/calflow/frontend`)
+3. Start the dev server (`npm run dev -- --host`)