Update README.md

README.md

@@ -1,24 +1,30 @@
-# README
+# Starting the Dev Server
-
+The development server can be run by executing the `dev` file in the `bin` directory.
-This README would normally document whatever steps are necessary to get the
+```bash
-application up and running.
+bin/dev
-
+```
-Things you may want to cover:
+
-
+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.
-* Ruby version
+## Dependencies
-
+### Posgres
-* System dependencies
+```bash
-
+sudo apt install postgresql-all 
-* Configuration
+```
-
+Then check if postgres is running with 
-* Database creation
+```bash
-
+sudo systemctl status postgresql.service 
-* Database initialization
+```
-
+Note: ensure the user you are running postgres as has necessary permissions. They can be added with:
-* How to run the test suite
+```bash
-
+sudo su - postgres
-* Services (job queues, cache servers, search engines, etc.)
+psql # enter postgres console
-
+ALTER USER my_user WITH Superuser;
-* Deployment instructions
+```
-
+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`