From 90a56bd51e5ad5e9ae93f210ea85f5eaaccdaf9d Mon Sep 17 00:00:00 2001
From: Alexander Berger <alexander.berger@jax.org>
Date: Tue, 5 Dec 2023 12:57:03 -0500
Subject: [PATCH] Updating readme to better reflect dev setup process

---
 README.MD | 27 +++++++++++++++++++++++----
 1 file changed, 23 insertions(+), 4 deletions(-)

diff --git a/README.MD b/README.MD
index 55fadd8..4b3f74c 100644
--- a/README.MD
+++ b/README.MD
@@ -1,7 +1,26 @@
-## Project Name: geneweaver-api
+# Geneweaver 3 API
 
-Description: description
+Description: The API for the Geneweaver v3 application ecosystem.
 
-App: geneweaver_api
+## Setup
 
-To run the app execute `uvicorn geneweaver_api.main:app --reload`
\ No newline at end of file
+### Local
+
+#### Requirements
+
+- Python Poetry
+- Python 3.9 or higher
+- A connection to a copy of the Geneweaver Database
+
+#### Setup
+
+1. Clone the repository
+2. Run `poetry install` in project root to install dependencies
+3. Configure environment settings with environment variables or a `.env` file.
+4. Run the application
+
+To run the app execute either `uvicorn geneweaver.api.main:app --reload` with the poetry
+virtualenv activated, or just run `poetry run uvicorn geneweaver.api.main:app --reload`.
+
+This will host the application on `http://127.0.0.1:8000/` which means the swagger docs
+page is available at `http://127.0.0.1:8000/docs`.