🚀 OctoCAT Supply Chain Management

Welcome to the OctoCAT Supply Website - an example website for showcasing the incredible capabilities of GitHub Copilot, and the power of AI-assisted development!

🏗️ 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

🚀 Getting Started

Prerequisites

• Node.js 18+ and npm

• Make

Quick Start

1. Clone this repository

2. From VS Code, open a new Git bash shell and install dependencies:

   make install

3. Start the development environment:

   make dev

This will start both the API server (on port 3000) and the frontend development server (on port 5173).

Available Make Commands

View all available commands:

make help

Key commands:

• make dev - Start both API and frontend development servers
• make dev-api - Start only the API server
• make dev-frontend - Start only the frontend server
• make build - Build both API and frontend for production
• make db-init - Initialize database schema
• make db-seed - Seed database with sample data
• make test - Run all tests
• make clean - Clean build artifacts and dependencies

Database Management

Initialize the database explicitly (migrations + seed):

make db-init

Seed data only:

make db-seed

Or use npm scripts directly in the API directory:

cd api && npm run db:migrate  # Run migrations only
cd api && npm run db:seed     # Seed data only

---

🤖 Challenges

This project is designed to showcase GitHub Copilot's capabilities. As such, it includes a series of challenges for you to try out:

Title	Details	Copilot Features
Challenge 1	Use Copilot to build a new feature and improve test coverage	Plan mode, Agent mode, Vision, Prompt Files
Challenge 2	Enforce team standards and delegate tasks to the custom Agent	Custom Instructions, Custom Agent

---