Skip to content

Commit 55acb2e

Browse files
committed
Update README
1 parent 88adfb1 commit 55acb2e

1 file changed

Lines changed: 9 additions & 2 deletions

File tree

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ for patients with bipolar disorder, helping them shorten their journey to stabil
66
## Usage
77

88
You can view the current build of the website here: [https://balancerproject.org/](https://balancerproject.org/)
9+
You can view the website in a sandbox here: [https://sandbox.balancerproject.org/](https://sandbox.balancerproject.org/)
910

1011
## Contributing
1112

@@ -31,11 +32,9 @@ Get the code using git by either forking or cloning `CodeForPhilly/balancer-main
3132
```
3233
2. (Optional) Add your API keys to `config/env/dev.env`:
3334
- `OpenAI API`
34-
- `Anthropic API`
3535

3636
Tools used for development:
3737
1. `Docker`: Install Docker Desktop
38-
2. `Postman`: Ask to get invited to the Balancer Postman team `balancer_dev`
3938
3. `npm`: In the terminal run 1) 'cd frontend' 2) 'npm install' 3) 'cd ..'
4039

4140
### Running Balancer for development
@@ -91,6 +90,14 @@ Most endpoints require JWT authentication. To test them in Swagger UI:
9190
3. **Test endpoints**: All subsequent requests will include your token. Use **Try it out** on any protected endpoint.
9291
4. **Token refresh**: Access tokens expire after 60 minutes. Use `POST /auth/jwt/refresh/` with your `refresh` token, or repeat step 1.
9392

93+
### Deployment
94+
95+
1. Merging your PR into develop automatically triggers a GitHub Release
96+
2. The release triggers a container build workflow that builds and pushes the Docker image
97+
3. [Go to GitHub Packages](https://github.com/CodeForPhilly/balancer-main/pkgs/container/balancer-main%2Fapp) to find the new image tag
98+
4. Update newTag in kustomization.yaml [in the cluster repo](https://github.com/CodeForPhilly/cfp-live-cluster/blob/main/balancer/kustomization.yaml)
99+
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))
100+
94101
## Architecture
95102

96103
The Balancer website is a Postgres, Django REST, and React project. The source code layout is:

0 commit comments

Comments
 (0)