Skip to content

cheeragpatel/demo_copilot_agent

Repository files navigation

🚀 OctoCAT Supply: The Ultimate GitHub Copilot Workshop

OctoCAT Supply

Welcome to the OctoCAT Supply Website - your go-to demo for learning the incredible capabilities of GitHub Copilot, GHAS, and the power of AI-assisted development!

Go to the Workshop Guide for a step-by-step learning path.

🏗️ Architecture

The application is built using modern TypeScript with a clean separation of concerns:

erDiagram
    Headquarters ||--o{ Branch: has
    Branch ||--o{ Order: placed_at
    Order ||--o{ OrderDetail: contains
    OrderDetail ||--o{ OrderDetailDelivery: fulfilled_by
    OrderDetail }|--|| Product: references
    Delivery ||--o{ OrderDetailDelivery: includes
    Supplier ||--o{ Delivery: provides
Loading

Tech Stack

  • Frontend: React 18+, TypeScript, Tailwind CSS, Vite
  • Backend: Express.js, TypeScript, SQLite, OpenAPI/Swagger
  • Data: SQLite (file db at api/data/app.db; in-memory for tests)
  • DevOps: Docker

🎯 Key Scenarios

  1. Vibe Coding

    • Implement a shopping cart from a design mockup
    • Watch Copilot analyze, plan, and implement across multiple files
    • Show real-time UI updates and state management
  2. Automated Testing

    • Generate BDD feature files
    • Create and execute Playwright tests
    • Enhance unit test coverage with intelligent test generation
  3. Security and Best Practices

    • Scan for vulnerabilities using GHAS
    • Generate automated fixes
    • Implement security best practices with Copilot guidance
  4. DevOps Automation

    • Generate GitHub Actions workflows
    • Create infrastructure as code
    • Set up container deployments

🚀 Getting Started

  1. Clone this repository
  2. Build the projects:
    # Build API and Frontend
    npm install && npm run build
  3. Start the application:
    npm run dev

Optional: initialize the database explicitly (migrations + seed):

npm run db:init --workspace=api

Handy DB scripts (API workspace):

# Run migrations only
npm run db:migrate --workspace=api

# Seed data only
npm run db:seed --workspace=api

Or use the VS Code tasks:

  • Cmd/Ctrl + Shift + P -> Run Task -> Build All
  • Use the Debug panel to run Start API & Frontend

🛠️ MCP Server Setup (Optional)

To showcase extended capabilities:

  1. Install Docker/Podman for the GitHub MCP server
  2. Use VS Code command palette:
    • MCP: List servers -> playwright -> Start server
    • MCP: List servers -> github -> Start server
  3. Configure with a GitHub PAT (required for GitHub MCP server)

📚 Documentation

Database defaults and env vars:

  • DB file: api/data/app.db (override with DB_FILE=/absolute/path/to/file.db)
  • Enable WAL: DB_ENABLE_WAL=true (default)
  • Foreign keys: DB_FOREIGN_KEYS=true (default)

This entire project, including the hero image, was created using AI and GitHub Copilot! Even this README was generated by Copilot using the project documentation. 🤖✨

About

No description, website, or topics provided.

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors