docs(api/backoffice): improve README

[Copilot]

Summary

• Rewrites the sparse apps-api/backoffice/README.md from a minimal stub into a full developer reference for @api/backoffice.

Added sections:

• Overview — what the service is and its role in the platform
• Technology stack — full table (Elysia, Prisma, PostgreSQL, OIDC/JWT, GCS, Firebase, Facebook Graph API, Vitest)
• Getting Started — monorepo-aware steps using correct pnpm --filter commands; fixes stale db:generate/db:migrate references to use actual @pple-today/database package scripts
• Environment variables — complete reference table for all 25+ vars grouped by concern (Core, OIDC, Facebook, GCS, Firebase, Ballot Crypto, External Services, Swagger)
• Development commands — all package.json scripts in one table
• API overview — base URL, versioning, bearer auth (today-cms:admin role), request/response conventions, error shape, HTTP status codes
• Key endpoints — reference tables for System, Application (public), and Admin route prefixes
• Swagger/OpenAPI — how to enable Scalar UI with bearer token and OAuth2 PKCE flows
• Code structure — annotated src/ directory tree
• Troubleshooting — DB connection, pending migrations, auth/401, CORS, Swagger not loading, Facebook webhook, Firebase FCM, tsx watch

Screenshots/Video

Steps to Test

1. Read through apps-api/backoffice/README.md and verify commands are accurate against package.json scripts and .env.example.
2. Confirm pnpm --filter @pple-today/database codegen and pnpm --filter @pple-today/database migrate are the correct database commands (replaces the previously documented but non-existent pnpm db:generate / pnpm db:migrate).
3. Follow the Getting Started steps in a clean environment to verify they work end-to-end.

Checklist

• Add Changeset
• Add Linear ID in PR title
• Perform Manual Testing

Note

Documentation-only change. No code, logic, or configuration was modified.

Original prompt

Update the documentation for the @api/backoffice package in the repository PPLEThai/pple-today by improving the README with useful information.

Requirements

1. Locate the README that documents @api/backoffice (likely within a packages/ or api/ directory). If no README exists for this package, create one in the most appropriate location.
2. Update/add content so it is genuinely useful to developers working in this repo. At minimum include:
   • What @api/backoffice is and what it’s used for in this project.
   • How to install/use it locally within the monorepo (e.g., workspace install commands).
   • Environment variables/configuration required (how to set them, where they live; include example .env keys without secrets).
   • How to run it (dev, build, start) and how to run tests/lint if applicable.
   • API usage overview: how to call it, request/response conventions, auth, base URL, versioning, and error handling (as applicable to the code).
   • Where to find related code (entrypoints, routes/controllers, OpenAPI/Swagger if present) and how to generate/update any API docs.
   • Any common troubleshooting tips (e.g., DB connection, migrations, CORS, auth token issues).
3. Ensure the README is well-structured with clear headings, concise examples, and commands that match the repo’s tooling (pnpm/yarn/npm) and existing scripts.
4. Keep information accurate by inspecting existing package.json scripts, configuration, and code structure.
5. No secrets: do not add real tokens/credentials.

Deliverable

• Open a pull request with the README updates/creation committed.
• PR title suggestion: "docs(api/backoffice): improve README"
• Include a brief PR description summarizing the documentation additions and where the README lives.

The following is the prior conversation context from the user's chat exploration (may be truncated):

User: Create a PR that update Readme for @api/backoffice
Provide useful informatioon

Assistant: I’ve prepared the pull request creation step for PPLEThai/pple-today, and we’re now waiting on your confirmation in the approval dialog before I can proceed with updating the @api/backoffice README and opening the PR.

This pull request was created from Copilot chat.

---

⌨️ Start Copilot coding agent tasks without leaving your editor — available in VS Code, Visual Studio, JetBrains IDEs and Eclipse.

[changeset-bot]

⚠️ No Changeset found

Latest commit: a311e48

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR