From e58874523baf9ca1bc6e234e6f20da63de5050e1 Mon Sep 17 00:00:00 2001
From: Gabe Farrell <gabe@mnrva.dev>
Date: Thu, 13 Apr 2023 20:37:10 -0400
Subject: [PATCH] Update README.md

---
 README.md | 54 ++++++++++++++++++++++++++++++------------------------
 1 file changed, 30 insertions(+), 24 deletions(-)

diff --git a/README.md b/README.md
index 7db80e4..466a261 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,30 @@
-# README
-
-This README would normally document whatever steps are necessary to get the
-application up and running.
-
-Things you may want to cover:
-
-* Ruby version
-
-* System dependencies
-
-* Configuration
-
-* Database creation
-
-* Database initialization
-
-* How to run the test suite
-
-* Services (job queues, cache servers, search engines, etc.)
-
-* Deployment instructions
-
-* ...
+# Starting the Dev Server
+The development server can be run by executing the `dev` file in the `bin` directory.
+```bash
+bin/dev
+```
+
+When running the development server for the first time, the postgres database will need to be created. You can do this by running `rails db:create` in the project directory.
+## Dependencies
+### Posgres
+```bash
+sudo apt install postgresql-all 
+```
+Then check if postgres is running with 
+```bash
+sudo systemctl status postgresql.service 
+```
+Note: ensure the user you are running postgres as has necessary permissions. They can be added with:
+```bash
+sudo su - postgres
+psql # enter postgres console
+ALTER USER my_user WITH Superuser;
+```
+Added permissions can be confirmed with `\du` within the psql console.
+## JavaScript Dependencies
+Install JS dependencies with:
+```bash
+yarn install
+```
+## Guard
+Guard is installed and can be run with `bundle exec guard`
\ No newline at end of file