Skip to content

Add production deployment and environment validation #26

@Lakes41

Description

@Lakes41

Summary

Add deployment guidance and runtime environment validation for the dashboard, integration client, optional Discord bot, and optional docs workspace.

Current Behaviour

The README covers local installation, mock data, development, build, start, typecheck, and lint commands. It does not provide a production deployment guide or central validation of required environment variables for live integrations.

Expected Behaviour

Maintainers should have a clear path for deploying the dashboard and enabling optional integrations safely.

Suggested Implementation

Add a deployment guide covering dashboard-only deployment, live integration mode, optional Discord bot deployment, docs deployment, environment variables, and smoke checks. Add environment parsing and validation where runtime values are used.

Files or Areas Likely Affected

  • README.md
  • docs/deployment.md
  • .env.example
  • apps/dashboard/lib/env.ts
  • apps/discord-bot/
  • apps/docs/
  • package.json

Acceptance Criteria

  • Dashboard deployment steps are documented
  • Live integration environment variables are documented
  • Optional Discord bot deployment requirements are documented
  • Optional docs deployment requirements are documented
  • Runtime environment values are validated before use
  • Post-deployment smoke checks are included

Additional Notes

Avoid documenting real credentials. Mark optional legacy workspaces clearly so dashboard-only deployments are not blocked by them.

Metadata

Metadata

Assignees

No one assigned

    Labels

    GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial CampaignCampaign: Official Campaign

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions