From 8415e27ff37957014a9669a54fc1fd9dee19fa2c Mon Sep 17 00:00:00 2001
From: ajdj100 <ajairplane@gmail.com>
Date: Mon, 26 Jan 2026 20:41:25 -0500
Subject: [PATCH] added readme

---
 readme.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..34ba44e
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,54 @@
+## Prerequs
+
+* Node.js
+* npm
+* Docker + Docker Compose
+
+## Installation
+
+Install dependencies in each workspace:
+
+```
+cd ui && npm install
+cd ../api && npm install
+cd ../shared && npm install
+```
+
+## Local Development Setup
+
+From the project root, start required services:
+
+```
+docker compose -f docker-compose.dev.yml up
+```
+
+Run database setup from `/api`:
+
+```
+npm run migrate:up
+npm run migrate:seed
+```
+
+## Running the App
+
+Start the frontend:
+
+```
+cd ui
+npm run dev
+```
+
+Start the API:
+
+```
+cd api
+npm run dev
+```
+
+* UI runs via Vite
+* API runs on Node after TypeScript build
+
+## Notes
+
+* `shared` must have its dependencies installed for both UI and API to work
+* `docker-compose.dev.yml` is required for local dev dependencies (e.g. database)
\ No newline at end of file