From 55f2359175b4ca60a2e1741b7cd42438cd6d5851 Mon Sep 17 00:00:00 2001
From: Jordan Lamoreaux <jlamoreaux@atlassian.com>
Date: Wed, 28 Feb 2024 10:18:02 -0600
Subject: [PATCH] update readme to make it easier for contributors

---
 README.md | 28 ++++++++++++++++++++++++++--
 1 file changed, 26 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index b60475f..eb0d33a 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,31 @@
 # learnbuildteach.com
 
-## Contribution
+## Running Locally
+To run locally, fork the repository and install the required dependancies:
+
+```bash
+npm i
+```
+
+Run by using the following command:
+
+```bash
+npm run dev
+```
 
 ### Supabase Credentials
+You will need access to the test Supabase instance for local development. For access, please send James (jamesqquick) a message on Discord!
+Once you have them, create a `.env` file in the root directory and add the credentials to the file. (See `env.example` for what that would look like)
+
+### Accessing Admin Area
+- navigate to `/signup` and create an account 
+- use your actual email address, use the link in the email from Supabase to confirm your account
+- you can now sign in at `/login`
+
+## Contributing
+Thank you for wanting to contribute to learnbuildteach.com! You may want to start by looking at some existing issues. If you notice something that needs improvement
+please create an issue outlining the probelm and then go ahead and start working on a PR.
 
-To get access to the test Supabase instance, please send James (jamesqquick) a message on Discord!
+Linting and formatting are handled via the following commands:
+- Lint: `npm run lint`
+- Format: `npm run format`
\ No newline at end of file