Skip to content

[ADD] Documentation #496

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sahilds1 merged 2 commits into from
Apr 14, 2026
Merged

[ADD] Documentation #496

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
88adfb1
Add issue template
sahilds1 Apr 14, 2026
55acb2e
Update README
sahilds1 Apr 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/issue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 -->
11 changes: 9 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down Expand Up @@ -91,6 +90,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:
Expand Down
Loading