From 82d2565fd6189c1bf07b239ec887d3ce9bd553ec Mon Sep 17 00:00:00 2001
From: Matteo Rosati <rosati.matteo@gmail.com>
Date: Wed, 18 Feb 2026 18:21:36 +0100
Subject: [PATCH] update README

---
 README.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/README.md b/README.md
index 70d4769..671c7ac 100644
--- a/README.md
+++ b/README.md
@@ -45,3 +45,35 @@ gcloud run deploy akern-assistant \
       --allow-unauthenticated \
       --set-secrets "GOOGLE_APPLICATION_CREDENTIALS_JSON=google-credentials:latest,AUTH_USER=auth-user:latest,PASSWORD=auth-password:latest"
 ```
+
+## Run the project locally
+
+### 1 - Install dependencies
+
+```sh
+uv sync
+```
+
+### 2 - Add the `credentials.json` to the project root
+
+The file must be asked to a coworker (ask Matteo or Antonio).
+
+### 3 - Run the database "migration"
+
+The project currently uses a very minimal sqlite3 db. To initialize it, run:
+
+```sh
+uv run models/orm.py
+```
+
+This will create the `example.db` file.
+
+After doing this, you will have to create at least one prompt record into the database. I suggest to use a SQLite viewer software for desktop called DB Browser for SQLite. Once you have downloaded the program, open the database that has just been created by the migration and add at least one row for one prompt.
+
+You can use the `prompt.md` file to have a prompt example. 
+
+### 4 - Run the dev server
+
+```sh
+uv run fastapi dev app.py
+```