Release: v1.1.6

.github/ISSUE_TEMPLATE/issue.md

@@ -0,0 +1,32 @@
+---
+name: Issue template
+about: Help push the project forward
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## 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 -->

.gitignore

@@ -1,3 +1,4 @@
 config/env/*
 !config/env/*.example
-.idea/
+.idea/
+.DS_Store

CLAUDE.md

@@ -147,6 +147,16 @@ Each module contains:
 - Auth endpoints via Djoser: `/auth/`
 - JWT token lifetime: 60 minutes (access), 1 day (refresh)
 
+#### API Documentation
+- Auto-generated using **drf-spectacular** (OpenAPI 3.0)
+- **Swagger UI**: `http://localhost:8000/api/docs/` — interactive API explorer
+- **ReDoc**: `http://localhost:8000/api/redoc/` — readable reference docs
+- **Raw schema**: `http://localhost:8000/api/schema/`
+- Configuration in `SPECTACULAR_SETTINGS` in `settings.py`
+- Views use `@extend_schema` decorators and `serializer_class` attributes for schema generation
+- JWT auth is configured in the schema — use `JWT <token>` (not `Bearer`) in Swagger UI's Authorize dialog
+- To document a new endpoint: add `serializer_class` to the view if it has one, or add `@extend_schema` with `inline_serializer` for views returning raw dicts
+
 #### Key Data Models
 - **Medication** (`api.views.listMeds.models`) - Medication catalog with benefits/risks
 - **MedRule** (`api.models.model_medRule`) - Include/Exclude rules for medications based on patient history

README.md

@@ -5,7 +5,9 @@ for patients with bipolar disorder, helping them shorten their journey to stabil
 
 ## Usage
 
-You can view the current build of the website here: [https://balancertestsite.com](https://balancertestsite.com/)
+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 +33,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
@@ -53,7 +53,7 @@ The application supports connecting to PostgreSQL databases via:
 See [Database Connection Documentation](./docs/DATABASE_CONNECTION.md) for detailed configuration.
 
 **Local Development:**
-- Download a sample of papers to upload from [https://balancertestsite.com](https://balancertestsite.com/) 
+- Download a sample of papers to upload from [https://balancerproject.org/](https://balancerproject.org/) 
 - The email and password of `pgAdmin` are specified in `balancer-main/docker-compose.yml`
 - The first time you use `pgAdmin` after building the Docker containers you will need to register the server.
     - The `Host name/address` is the Postgres server service name in the Docker Compose file
@@ -73,6 +73,36 @@ df = pd.read_sql(query, engine)
 
 #### Django REST
 - The email and password are set in `server/api/management/commands/createsu.py`
+- Backend tests can be run using `pytest` by running the below command inside the running backend container:
+
+```
+docker compose exec backend pytest api/ -v
+```
+
+## API Documentation
+
+Interactive API docs are auto-generated using [drf-spectacular](https://drf-spectacular.readthedocs.io/) and available at:
+
+- **Swagger UI**: [http://localhost:8000/api/docs/](http://localhost:8000/api/docs/) — interactive explorer with "Try it out" functionality
+- **ReDoc**: [http://localhost:8000/api/redoc/](http://localhost:8000/api/redoc/) — clean, readable reference docs
+- **Raw schema**: [http://localhost:8000/api/schema/](http://localhost:8000/api/schema/) — OpenAPI 3.0 JSON/YAML
+
+### Testing authenticated endpoints
+
+Most endpoints require JWT authentication. To test them in Swagger UI:
+
+1. **Get a token**: Find the `POST /auth/jwt/create/` endpoint in Swagger UI, click **Try it out**, enter an authorized `email` and `password`, and click **Execute**. Copy the `access` token from the response.
+2. **Authorize**: Click the **Authorize** button (lock icon) at the top of the page. Enter `JWT <your-access-token>` in the value field. The prefix must be `JWT`, not `Bearer`.
+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
 

deploy/manifests/balancer/base/deployment.yaml

@@ -21,6 +21,8 @@ spec:
           envFrom:
             - secretRef:
                 name: balancer-config
+            - configMapRef:
+                name: balancer-config
           ports:
             - containerPort: 8000
           readinessProbe:

deploy/manifests/balancer/base/gateway-listeners.yaml

@@ -0,0 +1,27 @@
+apiVersion: gateway.networking.k8s.io/v1
+kind: ListenerSet
+metadata:
+  name: balancer-listeners
+  annotations:
+    cert-manager.io/cluster-issuer: letsencrypt-prod
+    hostname: HOSTNAME_PLACEHOLDER
+spec:
+  parentRef:
+    name: main-gateway
+    namespace: envoy-gateway-system
+    group: gateway.networking.k8s.io
+    kind: Gateway
+  listeners:
+    - name: http
+      protocol: HTTP
+      port: 80
+      hostname: HOSTNAME_PLACEHOLDER
+    - name: https
+      protocol: HTTPS
+      port: 443
+      hostname: HOSTNAME_PLACEHOLDER
+      tls:
+        mode: Terminate
+        certificateRefs:
+          - name: balancer-tls
+            kind: Secret

deploy/manifests/balancer/base/httproute.yaml

@@ -0,0 +1,23 @@
+
+apiVersion: gateway.networking.k8s.io/v1
+kind: HTTPRoute
+metadata:
+  name: balancer
+  annotations:
+    hostname: HOSTNAME_PLACEHOLDER
+spec:
+  parentRefs:
+    - name: balancer-listeners
+      kind: ListenerSet
+      group: gateway.networking.k8s.io
+      sectionName: https
+  hostnames:
+    - HOSTNAME_PLACEHOLDER
+  rules:
+    - matches:
+        - path:
+            type: PathPrefix
+            value: /
+      backendRefs:
+        - name: balancer
+          port: 80

deploy/manifests/balancer/base/kustomization.yaml

@@ -5,4 +5,20 @@ resources:
   - namespace.yaml
   - deployment.yaml
   - service.yaml
-  - ingress.yaml
+  - gateway-listeners.yaml
+  - httproute.yaml
+
+labels:
+  - pairs:
+      app.kubernetes.io/name: balancer
+      app.kubernetes.io/part-of: balancer
+      app.kubernetes.io/managed-by: kustomize
+      app.kubernetes.io/component: web
+
+images:
+  - name: ghcr.io/codeforphilly/balancer-main/app
+
+configMapGenerator:
+  - name: balancer-config
+    envs:
+      - balancer.env

deploy/manifests/balancer/base/service.yaml

@@ -7,7 +7,7 @@ metadata:
 spec:
   ports:
     - name: http
-      port: 8000
+      port: 80
       targetPort: 8000
   selector:
     app: balancer

deploy/manifests/balancer/overlays/production/balancer.env

@@ -0,0 +1 @@
+CORS_ALLOWED_ORIGINS=https://balancerproject.org

deploy/manifests/balancer/overlays/production/kustomization.yaml

@@ -0,0 +1,44 @@
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+
+namespace: balancer
+
+resources:
+  - ../../base
+
+images:
+  - name: ghcr.io/codeforphilly/balancer-main/app
+    newTag: 1.1.5
+
+configMapGenerator:
+  - name: balancer-config
+    behavior: merge
+    literals:
+      - HOSTNAME=balancerproject.org
+    envs:
+      - balancer.env
+
+labels:
+  - includeSelectors: true
+    pairs:
+      environment: production
+      app.kubernetes.io/instance: balancer-production
+
+patches:
+  - target:
+      kind: ListenerSet
+      name: balancer-listeners
+    patch: |
+      - op: replace
+        path: /spec/listeners/0/hostname
+        value: balancerproject.org
+      - op: replace
+        path: /spec/listeners/1/hostname
+        value: balancerproject.org
+  - target:
+      kind: HTTPRoute
+      name: balancer
+    patch: |
+      - op: replace
+        path: /spec/hostnames/0
+        value: balancerproject.org

deploy/manifests/balancer/overlays/sandbox/balancer.env

@@ -0,0 +1 @@
+CORS_ALLOWED_ORIGINS=https://sandbox.balancerproject.org

deploy/manifests/balancer/overlays/sandbox/configmap.yaml

@@ -0,0 +1,10 @@
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: balancer-db-config
+data:
+  SQL_HOST: shared-cluster-rw.cloudnative-pg.svc.cluster.local
+  SQL_PORT: "5432"
+  SQL_DATABASE: balancer
+  SQL_USER: balancer
+  SQL_ENGINE: django.db.backends.postgresql