Skip to content

docs: document deployment, env vars, and API contracts#65

Open
daree-dev wants to merge 1 commit into
Kalebtron1:mainfrom
daree-dev:docs/issue-22-deployment-env-api
Open

docs: document deployment, env vars, and API contracts#65
daree-dev wants to merge 1 commit into
Kalebtron1:mainfrom
daree-dev:docs/issue-22-deployment-env-api

Conversation

@daree-dev
Copy link
Copy Markdown
Contributor

  • Update .env.example with ownership and sensitivity labels for all variables
  • Add docs/deployment.md: local setup, Vercel deploy, rollback, contract redeployment
  • Add docs/api.md: full contracts for all 5 API endpoints with request/response shapes and error codes
  • Update README.md to link deployment and API docs

Closes #22

Verification:
npm run build — passes without errors Docs follow fresh-setup dry-run path from clone to running app

- Update .env.example with ownership and sensitivity labels for all variables
- Add docs/deployment.md: local setup, Vercel deploy, rollback, contract redeployment
- Add docs/api.md: full contracts for all 5 API endpoints with request/response shapes and error codes
- Update README.md to link deployment and API docs

Closes Kalebtron1#22

Verification:
  npm run build  — passes without errors
  Docs follow fresh-setup dry-run path from clone to running app
@vercel
Copy link
Copy Markdown

vercel Bot commented May 31, 2026

@daree-dev is attempting to deploy a commit to the alankcr1-6443's projects Team on Vercel.

A member of the Team first needs to authorize it.

@drips-wave
Copy link
Copy Markdown

drips-wave Bot commented May 31, 2026

@daree-dev Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document deployment, environment variables, and API contracts

1 participant