Merge pull request #496 from sahilds1/187-add-docs

[ADD] Documentation

Author: sahilds1

.github/ISSUE_TEMPLATE/issue.md

@@ -0,0 +1,23 @@
+## Title
+<!-- Title: [Type]: Short description of the problem or goal  -->
+
+## Background
+<!-- Why does this change need to happen? -->
+
+## Existing Behavior
+<!-- What code or docs are changing? Link or paste as needed -->
+
+## Acceptance Criteria
+- [] <!-- What does done look like? -->
+
+## Approach
+<!-- How are you tackling this? Update as you go -->
+
+## References
+<!-- Anything useful — docs, links, decisions -->
+
+## Risks and Rollback
+<!-- Anything that could go wrong, or leave blank if low risk -->
+
+## Screenshots / Recordings
+<!-- Before/after visuals or console output if helpful -->

README.md

@@ -6,6 +6,7 @@ for patients with bipolar disorder, helping them shorten their journey to stabil
 ## Usage
 
 You can view the current build of the website here: [https://balancerproject.org/](https://balancerproject.org/)
+You can view the website in a sandbox here: [https://sandbox.balancerproject.org/](https://sandbox.balancerproject.org/)
 
 ## Contributing 
 
@@ -31,11 +32,9 @@ Get the code using git by either forking or cloning `CodeForPhilly/balancer-main
    ```
 2. (Optional) Add your API keys to `config/env/dev.env`:
    - `OpenAI API`
-   - `Anthropic API`
 
 Tools used for development:
 1. `Docker`: Install Docker Desktop
-2. `Postman`: Ask to get invited to the Balancer Postman team `balancer_dev`
 3. `npm`: In the terminal run 1) 'cd frontend' 2) 'npm install' 3) 'cd ..'
 
 ### Running Balancer for development
@@ -96,6 +95,14 @@ Most endpoints require JWT authentication. To test them in Swagger UI:
 3. **Test endpoints**: All subsequent requests will include your token. Use **Try it out** on any protected endpoint.
 4. **Token refresh**: Access tokens expire after 60 minutes. Use `POST /auth/jwt/refresh/` with your `refresh` token, or repeat step 1.
 
+### Deployment 
+
+1. Merging your PR into develop automatically triggers a GitHub Release
+2. The release triggers a container build workflow that builds and pushes the Docker image
+3. [Go to GitHub Packages](https://github.com/CodeForPhilly/balancer-main/pkgs/container/balancer-main%2Fapp) to find the new image tag 
+4. Update newTag in kustomization.yaml [in the cluster repo](https://github.com/CodeForPhilly/cfp-live-cluster/blob/main/balancer/kustomization.yaml)
+5. Open a PR to [cfp-sandbox-cluster](https://github.com/CodeForPhilly/cfp-sandbox-cluster) (or [cfp-live-cluster](https://github.com/CodeForPhilly/cfp-live-cluster))
+
 ## Architecture
 
 The Balancer website is a Postgres, Django REST, and React project. The source code layout is: