Added streamlit to readme & docs update(new make commands)

README.md

@@ -162,14 +162,24 @@ Note that the Flask server must be running in order to send emails.
     <img src="images/website.gif" alt="cli-surf_website gif" style="width: 700px; height: auto;">
 </p>
 
-Although this application was made with the cli in mind, there is a frontend.
+Although this application was made with the cli in mind, there are two frontends (experimenting at the moment).
+
+**HTML/JS/CSS Frontend**
 
 `http://localhost:8000/home` **or** `<ip_of_host>:<port>/home` if the application is running on a different host or you have changed the default port.
 
 You may need to change `IP_ADDRESS` in `.env` to match the ip of the host running the machine.
 
 Now, running `python3 server.py` will launch the website!
 
+**Streamlit Frontend**
+
+[Streamlit](https://streamlit.io/) is also an option that we are experimenting with. 
+
+To run streamlit: `streamlit run src/dev_streamlit.py`
+
+You will be able to find the frontend here: `http://localhost:8502`
+
 
 ## 📈 Contributing
 

docs/cheat_sheet.md

@@ -18,7 +18,7 @@ When developing, these commands may come in handy:
 |  `poetry add <package-name>` |  Add a new dependency to Poetry |
 | `poetry add --group dev <package-name>`  |  Add a new developer dependency to Poetry |
 | `poetry show`  |  List all available dependencies with descriptions |
-| `poetry run pre-commit run --all-files`  |  Run the Linter & Formatter |
+| `pre-commit run --all-files`  |  Run the Linter & Formatter |
 
 ## [Mkdocs Commands](https://www.mkdocs.org/user-guide/)
 
@@ -30,12 +30,15 @@ When developing, these commands may come in handy:
 
 | Argument    | Description|
 | -------- | ------- |
+| `make install`  |  Install dependencies and activates the virtual environment. |
 | `make run`  |  Runs `server.py` |
 | `make run_docker`  |  Runs `docker compose up -d` |
 | `make test`  |  Runs pytest |
 | `make test_docker`  |  Runs pytest on Docker |
 | `make output_coverage`  |  Outputs the coverage of the tests |
 | `make send_email`  |  Runs `send_email.py` |
+| `make lint`  |  Runs the ruff linter |
+| `make format`  |  Runs the ruff formatter |
 
 
 ## [Git](https://education.github.com/git-cheat-sheet-education.pdf)
@@ -51,4 +54,5 @@ When developing, these commands may come in handy:
 | `git checkout -b <branch>`  |  Creates a new branch, `branch`, and switches into it |
 | `git branch -d <branch>`  |  Delete a local branch |
 | `git push -u origin <branch-name>`  |  Pushes a local branch to the upstream remote repo |
-| `git log --branches --not --remotes`  |  View commits that have not yet been pushed |
+| `git log --branches --not --remotes`  |  View commits that have not yet been pushed |
+| `git fetch origin pull/ID/head:BRANCH_NAME`  |  Checking out a PR branch with `ID` and `BRANCH_NAME` |

docs/styling.md

@@ -7,4 +7,6 @@ This is achieved using the ruff Linter and Formatter.
 
 The Linter and Formatter are automatically executed before committing via pre-commit.
 
-If you want to run the Linter and Formatter at any time, execute `poetry run pre-commit run --all-files`.
+If you want to run the Linter and Formatter at any time, execute `pre-commit run --all-files`.
+
+You may also run `make lint` or `make format` to run the linter/formatter on its own.