From 272abf5880e4347bdbd35b6f597569039b27ebdc Mon Sep 17 00:00:00 2001
From: AaronLieb <aarnliebrmn@gmail.com>
Date: Sat, 31 Aug 2024 19:11:43 -0700
Subject: [PATCH] Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5ace86b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,49 @@
+# Snapshot
+
+A simple game with the primary interface being sms
+
+Users are able to sign up by texting a specific number, and will receive a
+weekly prompt. Users can submit a photo for the prompt by sending an image over sms
+
+Once a user has submitted a response, they will receive a link to a webpage to
+view all of the photos submitted by users.
+
+API built using FastAPI.
+Uses Twilio api for the sms interface
+SQLAlchemy as an ORM for Sqlite3.
+
+### Development
+
+Initialize the database
+
+```bash
+sqlite3 snapshot.db < schema.sql
+```
+
+Setup the .env
+```
+environment=
+twilio_account_sid=
+twilio_auth_token=
+twilio_phone_number=
+db_name=
+hash_secret=
+admin_pass=
+beta_code=
+beta_allowlist=
+```
+
+Run the tests
+```bash
+pytest
+```
+
+Start the server
+```bash
+fastapi run main.py
+```
+
+Format code before new changes
+```bash
+black .
+```