Improve Readme

.env

@@ -2,3 +2,4 @@ REACT_APP_SOCKET_API_URL='https://socket.tutorcruncher.com'
 PUBLIC_URL='/'
 REACT_APP_GRECAPTCHA_KEY='6LdyXRgUAAAAADUNhMVKJDXiRr6DUN8TGOgllqbt'
 REACT_APP_RELEASE='-'
+REACT_EDITOR=pycharm

README.md

@@ -15,4 +15,34 @@ It defaults to use the TutorCruncher Socket backend, but you can use your own if
 
 Alternatively, you can just use TutorCruncher's API and build your own frontend.
 
-[More documentation](https://help.tutorcruncher.com/en/articles/4843207-socket).
+[Help Article](https://help.tutorcruncher.com/en/articles/4843207-socket).
+
+
+## Setup and Run locally
+
+To set up and run this project, follow these steps:
+
+1. **Install dependencies:**
+   ```sh
+    nvm install 14
+    nvm use 14
+    yarn install
+   ```
+2. **Run the application:**
+   ```sh
+    yarn start
+   ```
+3. **Set the environment variables:**
+   ```sh
+    REACT_APP_SOCKET_API_URL='http://localhost:8000'
+   ```
+4. **Set the company public api key:**
+
+   in `public/index.html` set `public_key` with the company's public api key
+   - dino tutors is = `9c79f14df986a1ec693c`
+
+5. **Set api root:**
+
+   in `public/index.html` set `api_root` to the root of the api
+   - for local testing it is `http://localhost:8000`
+   - to use socket-beta it is `https://socket-beta.tutorcruncher.com`

src/components/shared/Error.js

@@ -1,6 +1,6 @@
 import React from 'react'
 
-const HELP_SITE = 'help.tutorcruncher.com/tc-socket/'
+const HELP_SITE = 'https://help.tutorcruncher.com/en/articles/8255881-getting-started-with-tutorcruncher-socket'
 
 const Error = ({children}) => (
   <div className="tcs-errors">