blockpy-edu
Add comprehensive GitHub Copilot instructions for BlockPy Server development
This PR adds comprehensive development instructions for GitHub Copilot coding agents working with the BlockPy Server repository. The instructions provide detailed setup procedures, build commands, timing expectations, and troubleshooting guidance for this Flask-based educational LTI application.
Key Features
Complete Development Workflow: Step-by-step instructions covering Python virtual environment setup, frontend TypeScript build process, database configuration, and both local development and Docker-based deployment.
Critical Timing Information: All commands include measured execution times and appropriate timeout recommendations:
- Python package installation: 3-5 minutes (10+ minute timeout)
- Frontend builds: 30-60 seconds (5+ minute timeout)
- Docker builds: 10-20 minutes (30+ minute timeout)
Network Issue Handling: Documents common PyPI connectivity problems with SSL certificate errors and provides specific workarounds using trusted hosts and increased timeouts.
Comprehensive Validation: Manual testing procedures to verify application functionality after changes, including database connectivity, frontend builds, and complete user workflow validation.
Architecture Overview: Clear explanation of the Flask backend with PostgreSQL, TypeScript frontend with Webpack, Redis task queue, and Docker Compose deployment stack.
The instructions follow an imperative tone ("Run this command", "Set timeout to X minutes") and prioritize commands that have been validated to work. They include extensive troubleshooting sections for common issues like dependency conflicts, database connection problems, and Docker service failures.
This enables GitHub Copilot agents to work effectively with the codebase from a fresh clone, understanding both the development workflow and the expected challenges in the environment.
Fixes #67.
💡 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.
