Update README.md

README.md

@@ -42,12 +42,43 @@ After the first commit, you don't need to copy/paste the above again, you can ma
 ### Adding a reviewer
 Tell someone who is in the `Admin` team to review the code and merge the pull request. You can manually add a reviewer if you'd like.
 
+### Get your Environment Variables
+In the root folder your will find the `.env.example` file, make a copy and name it `.env`.
+
+Here you will need to generate your own variables for development.
+
+1. `NEXTAUTH_SECRET`: run `openssl rand -base64 32` in your Git Bash
+
+2. For step two, you will need to have PostgreSQL installed. Install it, create a new server, a new database and new user.
+
+For this example let's assume you decided to generate a database and user with the following credentials: `mydatabase`, `myuser`, `mypassword`, `5432` (this will be the port.)
+
+Then these will be your .env variables:
+
+```
+POSTGRES_URL="postgresql://myuser:mypassword@localhost:5432/mydatabase"
+POSTGRES_PRISMA_URL="postgresql://myuser:mypassword@localhost:5432/mydatabase"
+POSTGRES_URL_NO_SSL="postgresql://myuser:mypassword@localhost:5432/mydatabase"
+POSTGRES_URL_NON_POOLING="postgresql://myuser:mypassword@localhost:5432/mydatabase"
+POSTGRES_USER="myuser"
+POSTGRES_HOST="localhost"
+POSTGRES_PASSWORD="mypassword"
+POSTGRES_DATABASE="mydatabase"
+```
+
+3. `BLOB_READ_WRITE_TOKEN`: This is the token to the Vercel storage and is only used in the sign-in screen.
+
+### Other Things You Need to Do For Initial Setup
+Run `npx prisma generate`
+
+## Running the app
+`npm run dev`
+
 # Some To-dos
 Some to-dos. These were last updated May 2024.
 
 - [ ] Convert `auth.socis.ca` to use JWT for sign up link and password reset link (**THIS IS VERY IMPORTANT**)
 - [ ] Sign out button in `account.socis.ca`
-
 - [ ] Convert `<form>`'s to `react-hook-form` and `zod`
 - [ ] Fix UI: Padding, more responsive on mobile, etc.
 - [ ] Migrate from Vercel Blob Storage to AWS S3 or another S3 provider (Vercel’s blob storage limits are too low)