Skip to content

Comments

Add development.md documentation for developer onboarding#60

Draft
Copilot wants to merge 4 commits intomainfrom
copilot/create-development-documentation
Draft

Add development.md documentation for developer onboarding#60
Copilot wants to merge 4 commits intomainfrom
copilot/create-development-documentation

Conversation

Copy link

Copilot AI commented Feb 14, 2026

Adds comprehensive developer documentation to streamline onboarding and standardize development practices across the full-stack JavaScript codebase.

Documentation Structure

  • Architecture & Setup: Client-server overview, prerequisites (Node.js 18+, PostgreSQL 15+), Google OAuth configuration, environment setup
  • Development Workflows: Frontend (Vite), Backend (Express + TypeScript + Prisma), database migrations, local/staging/production environments
  • API Reference: Authentication, Games, Sessions endpoints with ownership models
  • Contribution Guide: Git workflow, PR process, issue referencing conventions, testing approach
  • Troubleshooting: Common failure scenarios for CORS, database connections, build processes

Key Technical Details

  • Documents existing mobile touch/zoom functionality (referenced from Feat: create a "re-centre" button #58) and notes future re-center button enhancement
  • Clarifies PostgreSQL SSL requirements differ for local vs. production (NeonDB)
  • Recommends Vitest over Jest for Vite configuration compatibility
  • Maps deployment targets: GitHub Pages (static assets) + Vercel (serverless API)

File Coverage

Single file: development.md (727 lines)

Complements existing README.md and backend/README.md with operational details for active development.

Original prompt

Create a development.md documentation file for the "String-sg/bingo-string" repository. Make sure to include key information and guidelines derived from issue #58 and the main codebase.

This pull request was created from Copilot chat.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@vercel
Copy link

vercel bot commented Feb 14, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
bingo-string Ready Ready Preview, Comment Feb 14, 2026 1:38am

Co-authored-by: ghostleek <44336310+ghostleek@users.noreply.github.com>
…ommendations

Co-authored-by: ghostleek <44336310+ghostleek@users.noreply.github.com>
…SSL config

Co-authored-by: ghostleek <44336310+ghostleek@users.noreply.github.com>
Copilot AI changed the title [WIP] Add development documentation for bingo-string repository Add development.md documentation for developer onboarding Feb 14, 2026
Copilot AI requested a review from ghostleek February 14, 2026 01:39
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.

2 participants