Skip to content

docs: add deployment configs, CI, and comprehensive documentation#20

Merged
Emart29 merged 1 commit intomainfrom
codex/set-up-deployment-and-create-documentation
Feb 4, 2026
Merged

docs: add deployment configs, CI, and comprehensive documentation#20
Emart29 merged 1 commit intomainfrom
codex/set-up-deployment-and-create-documentation

Conversation

@Emart29
Copy link
Contributor

@Emart29 Emart29 commented Feb 4, 2026

Motivation

  • Provide ready-to-use deployment configuration for common hosts (Railway, Render, Vercel) so the project can be deployed without Docker.
  • Improve onboarding and community contribution by adding a complete documentation set and GitHub templates.
  • Add helper scripts for local development and test orchestration to standardize contributor workflows.

Description

  • Added backend deployment files: backend/railway.json, backend/Procfile, backend/runtime.txt, and backend/render.yaml and updated startup commands to use src.iopsdata.api.main.
  • Added frontend deployment/config: frontend/vercel.json and frontend/next.config.js (replacing next.config.ts) with image domains and environment validation.
  • Added GitHub automation and community files: .github/workflows/ci.yml, issue templates in .github/ISSUE_TEMPLATE/, PULL_REQUEST_TEMPLATE.md, CODEOWNERS, and FUNDING.yml.
  • Added a full documentation suite under docs/ (README.md, INSTALLATION.md, DEPLOYMENT.md, CONFIGURATION.md, ARCHITECTURE.md, API.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md, CHANGELOG.md, ROADMAP.md, FAQ.md) plus updated root README.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md, and consolidated .env.example, backend/.env.example, and frontend/.env.example samples.
  • Added local helper scripts: scripts/dev.sh to run frontend + backend concurrently and scripts/test.sh to run backend pytest and linting and frontend checks, plus small fixes to scripts/setup.sh and scripts/setup.ps1 to point to the correct FastAPI entry module.

Testing

  • No automated test runs were executed in this change because the patch is configuration and documentation focused.
  • A CI workflow (.github/workflows/ci.yml) was added to run pytest for the backend, build the frontend (pnpm build), and run linting (ruff and eslint).
  • Local helper scripts were added to make running tests and development (./scripts/test.sh, ./scripts/dev.sh) reproducible for contributors.

Codex Task

@Emart29 Emart29 merged commit 23508b6 into main Feb 4, 2026
0 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant