From ea91d4cf04c08373254218b57b0bea47e310d748 Mon Sep 17 00:00:00 2001
From: Erika Rowland <accounts@erikarowland.com>
Date: Sun, 10 Mar 2024 19:34:41 -0700
Subject: [PATCH] docs: Add basic readme

---
 README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e854a69
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+# Queen
+
+## Setting up dev environment
+
+Copy the `.env.example` to `.env` then fill in missing variables:
+
+```sh
+cp .env.example .env
+```
+
+Use `sqlx-cli` (install using `cargo install sqlx-cli`) to create and migrate the database:
+
+```sh
+sqlx db create ; sqlx migrate run
+```
+
+## Development
+
+Run the server for development:
+
+```
+cargo run
+```
+
+The assets used in Queen come from forgejo, 
+so you can use a local Caddyfile to serve both forgejo and `queen`
+(assuming that forgejo is running on localhost:3000):
+
+```
+{
+  http_port 9000
+}
+
+localhost:9000 {
+	reverse_proxy /signup* localhost:4008
+	reverse_proxy /payment_success* localhost:4008
+	reverse_proxy localhost:3000
+}
+```
+
+Run caddy with:
+
+```
+caddy run --config Caddyfile
+```