Skip to content

Classic Mini DIY is the best place to find all the reference material, how-to videos, and much much more for your Classic Mini

License

Notifications You must be signed in to change notification settings

ClassicMiniDIY/classicminidiy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Contributors Forks Stargazers Issues License


Logo

Classic Mini DIY

The most comprehensive digital archive and technical resource for Classic Mini enthusiasts worldwide. This project provides an extensive collection of tools, documentation, and interactive features for Classic Mini owners, mechanics, and enthusiasts. All resources are free, open source, and designed to be permanently accessible.

Explore the website ยป

Report Bug ยท Request Feature ยท Support Server Costs

Table of Contents
  1. About The Project
  2. Getting Started
  3. Features Overview
  4. Technical Toolbox
  5. Archive System
  6. AI-Powered Features
  7. API Documentation
  8. Internationalization
  9. Contributing
  10. Deployment
  11. Support
  12. License

About The Project

Product Name Screen Shot

Classic Mini DIY is a comprehensive web application serving as both a toolkit and permanent archive for Classic Mini enthusiasts. The project combines technical calculators, historical documentation, user-generated content systems, and AI-powered assistance to create the most complete digital resource for Classic Mini owners worldwide.

Current Version: 3.5.4

The platform is designed to be both a real-time working tool for mechanics and enthusiasts, and a permanent digital archive ensuring Classic Mini knowledge is preserved for future generations. All content is backed up across multiple cloud locations and designed to remain accessible indefinitely.

Built With

This project leverages modern web technologies for optimal performance, accessibility, and maintainability:

Nuxt Vue TypeScript TailwindCSS AWS Vercel

Core Technologies:

  • Nuxt 4.1.2 - Vue.js framework with server-side rendering
  • Vue 3 - Progressive JavaScript framework with Composition API
  • TypeScript - Strict type checking and enhanced development experience
  • TailwindCSS 4.1.13 - Utility-first CSS framework with custom DaisyUI theme
  • AWS Services - S3 storage, DynamoDB database, intelligent tiering
  • LangGraph SDK - AI-powered conversational assistance
  • Highcharts - Interactive data visualization and charts
  • Fuse.js - Advanced fuzzy search functionality

Infrastructure:

  • Vercel - Serverless hosting with global edge deployment
  • AWS S3 - Intelligent tiering storage with versioning
  • DynamoDB - NoSQL database for user-generated content
  • PostgreSQL - Content management database
  • CDN - Global content delivery network

(back to top)

Key Features

  • ๐Ÿ”ง 8 Interactive Technical Calculators - Compression ratio, gearbox, SU carburetors, and more
  • ๐Ÿ“š Comprehensive Digital Archive - Workshop manuals, wiring diagrams, historical documents
  • ๐Ÿค– AI-Powered Assistant - LangGraph-based conversational AI with technical expertise
  • ๐ŸŒ Multi-Language Support - Full internationalization across 10 languages
  • ๐Ÿ“ฑ Progressive Web App - Offline functionality and mobile-optimized experience
  • ๐ŸŽจ User-Generated Content - Registry system, wheel library, color database
  • ๐Ÿ” Advanced Search - Fuse.js powered fuzzy search across all content
  • ๐Ÿ›’ ECU Maps Store - Multi-platform tuning maps with GitHub integration
  • ๐Ÿ” Admin Panel - Content review and approval workflows
  • โšก High Performance - Optimized builds, caching, and CDN delivery

Getting Started

Prerequisites

  • Node.js v22.12.0 or higher
  • npm (comes with Node.js)
  • Git for version control

Installation

  1. Clone the repository

    git clone https://github.com/somethingnew71/classicminidiy.git
    cd classicminidiy
  2. Install dependencies

    npm install
  3. Start development server

    npm run dev
  4. Open your browser Navigate to http://localhost:3000 to see the application

Environment Setup

Create a .env file in the root directory with the following variables:

# AWS Credentials
dynamo_id=your_dynamodb_access_key
dynamo_key=your_dynamodb_secret_key
s3_id=your_s3_access_key
s3_key=your_s3_secret_key

# External APIs
githubAPIKey=your_github_api_key
youtubeAPIKey=your_youtube_api_key
validation_key=your_validation_key

# AI Services
NUXT_LANGGRAPH_API_URL=your_langgraph_api_url
NUXT_LANGSMITH_API_KEY=your_langsmith_api_key

# Database
POSTGRES_URL=your_postgresql_connection_string

# Public URLs
NUXT_PUBLIC_SITE_URL=https://classicminidiy.com
s3Base=https://classicminidiy.s3.us-east-1.amazonaws.com

# Admin Authentication (for admin panel)
ADMIN_USERNAME=your_admin_username
ADMIN_PASSWORD=your_admin_password

Available Scripts

# Development
npm run dev          # Start development server
npm run build        # Build for production
npm run start        # Preview production build
npm run format       # Format code with Prettier

(back to top)

Features Overview

Technical Toolbox

The technical toolbox provides interactive calculators and reference tools essential for Classic Mini maintenance and modification:

Calculators & Tools

  • ๐Ÿ”ง Compression Ratio Calculator (/technical/compression)

    • Engine compression calculations with piston, crankshaft, head gasket configurations
    • Real-time calculations with visual feedback
    • Support for custom measurements and part specifications
  • โš™๏ธ Gearbox Calculator (/technical/gearing)

    • Gear ratio calculations and speed computations
    • Multiple gearbox configurations
    • RPM and speed analysis tools
  • ๐Ÿ“Š SU Carb Needle Configurator (/technical/needles)

    • Interactive needle comparison with Highcharts visualization
    • Comprehensive needle database
    • Performance curve analysis
  • ๐Ÿ” Chassis Number Decoder (/technical/chassis-decoder)

    • Historical chassis number database and identification
    • Year and model identification
    • Production date estimation
  • ๐Ÿท๏ธ Engine Number Decoder (/technical/engine-decoder)

    • Engine code interpretation and specifications
    • Performance data and compatibility information
    • Historical engine database

Reference Materials

  • ๐Ÿ“ Common Clearances Reference (/technical/clearance)

    • Comprehensive clearance specifications by system
    • Tolerance ranges and recommended values
    • Searchable database of technical specifications
  • ๐Ÿ”— Parts Equivalency Database (/technical/parts)

    • Cross-reference part numbers between brands
    • Alternative part identification
    • Compatibility matrices
  • ๐Ÿ”ฉ Torque Specifications Chart (/technical/torque)

    • Complete torque specification database
    • Organized by system and component
    • Imperial and metric measurements

Archive System

The archive system preserves and organizes historical Classic Mini documentation:

Historical Documentation

  • ๐Ÿ“– Workshop Manuals (/archive/manuals)

    • Complete digitized workshop manuals with full-text search
    • High-resolution scanned pages
    • Organized by year and model
  • โšก Electrical Wiring Diagrams (/archive/electrical)

    • Positive and negative ground systems by year and model
    • Color-coded wiring diagrams
    • Interactive diagram viewer
  • ๐Ÿ“ฐ Historical Advertisements (/archive/adverts)

    • Period advertising materials and brochures
    • Marketing materials from different eras
    • Searchable archive with metadata
  • ๐Ÿ“š Vendor Catalogues (/archive/catalogues)

    • Historical parts catalogs and documentation
    • Vendor-specific information
    • Product evolution tracking
  • ๐Ÿ Tuning & Modifications (/archive/tuning)

    • Performance modification guides and specifications
    • Historical tuning documentation
    • Competition and racing modifications

User-Generated Content

  • ๐Ÿ† Registry System (/archive/registry)

    • User-submitted Classic Mini registrations with admin approval
    • Photo galleries and specifications
    • Historical ownership tracking
  • ๐ŸŽฏ Wheel Fitment Library (/archive/wheels)

    • Comprehensive wheel database with user photos
    • Fitment data and compatibility information
    • Size and offset calculations
  • ๐ŸŽจ Color Database (/archive/colors)

    • Historical paint colors with hex values and user contributions
    • Color matching and identification
    • Period-correct color schemes
  • ๐Ÿš— Engine Specifications (/archive/engines)

    • Complete engine database with performance specifications
    • Power and torque curves
    • Modification potential analysis
  • โš–๏ธ Vehicle Weights Reference (/archive/weights)

    • Weight specifications by model and year
    • Distribution data and balance points
    • Performance impact calculations

AI-Powered Features

CMDIY Assistant (/chat)

  • ๐Ÿค– Conversational AI - LangGraph-powered assistant with Classic Mini expertise
  • ๐Ÿ“‹ Model Context Protocol (MCP) Server - Integration with calculators and tools
  • ๐Ÿ’ฌ Streaming Responses - Real-time AI chat with persistent conversation threads
  • ๐Ÿง  Context Awareness - Understanding of Classic Mini technical specifications
  • ๐Ÿ”ง Tool Integration - Direct access to calculators and reference materials

Administrative Features

Content Management (/admin)

  • โœ… Registry Review System (/admin/registry/review)

    • Approve/reject user submissions
    • Content moderation and quality control
    • Batch processing capabilities
  • ๐Ÿ›ž Wheel Review System (/admin/wheels/review)

    • Review user-submitted wheel data
    • Image processing and validation
    • Data quality assurance
  • ๐Ÿ” Authentication System

    • Secure admin login and session management
    • Role-based access control
    • Session persistence and security

E-commerce Integration

ECU Maps Store (/maps)

  • ๐Ÿ–ฅ๏ธ Multi-ECU Support - Haltech, Speeduino, MegaSquirt, and more
  • ๐Ÿ”„ GitHub Integration - Real-time repository updates and release management
  • ๐Ÿ“Š Feature Matrix - Ignition maps, fuel maps, VE tables, target AFR configurations
  • ๐Ÿ’พ Download Management - Secure file delivery and version control

(back to top)

API Documentation

The Classic Mini DIY platform exposes over 50 REST API endpoints for various functionalities:

Technical Tools APIs

  • GET /api/decoders/chassis - Chassis number decoding by year ranges
  • GET /api/decoders/engine - Engine code interpretation and identification
  • POST /api/mcp/compression - MCP integration for compression calculator
  • POST /api/mcp/gearbox - MCP integration for gearbox calculator
  • POST /api/mcp/chassis - MCP integration for chassis decoding

Database APIs

  • GET /api/wheels/ - Wheel fitment database with image handling
  • GET /api/registry/ - User registration system with approval workflow
  • GET /api/colors/ - Paint color database with user contributions
  • GET /api/engines/ - Engine specifications and performance data
  • GET /api/weights/ - Vehicle weight specifications

AI & Chat APIs

  • POST /api/langgraph/ - AI chat integration with streaming responses
  • GET/POST /api/mcp/ - Model Context Protocol server for tool integration

Administrative APIs

  • GET /api/admin/registry/review - Registry submission review and approval
  • GET /api/admin/wheels/review - Wheel submission review and management
  • POST /api/admin/auth - Authentication and session management

Content & Media APIs

  • GET /api/github/ - Repository statistics, commits, and release data
  • GET /api/youtube/ - Channel statistics and video integration
  • GET /api/maps/ - ECU maps store with GitHub integration

External Integrations

  • GitHub API - Repository statistics, commits, releases, automated content updates
  • YouTube API - Channel statistics, video feeds, content synchronization
  • AWS Services - S3 storage operations, DynamoDB queries and transactions

(back to top)

Internationalization

Classic Mini DIY supports 10 languages with comprehensive internationalization:

Supported Languages

  • ๐Ÿ‡บ๐Ÿ‡ธ English (en) - Primary language
  • ๐Ÿ‡ช๐Ÿ‡ธ Spanish (es) - Comprehensive coverage
  • ๐Ÿ‡ซ๐Ÿ‡ท French (fr) - Full translation
  • ๐Ÿ‡ฉ๐Ÿ‡ช German (de) - Most complete translations
  • ๐Ÿ‡ฎ๐Ÿ‡น Italian (it) - Complete coverage
  • ๐Ÿ‡ต๐Ÿ‡น Portuguese (pt) - Full translation
  • ๐Ÿ‡ท๐Ÿ‡บ Russian (ru) - Complete coverage
  • ๐Ÿ‡ฏ๐Ÿ‡ต Japanese (ja) - Full translation
  • ๐Ÿ‡จ๐Ÿ‡ณ Chinese (zh) - Complete coverage
  • ๐Ÿ‡ฐ๐Ÿ‡ท Korean (ko) - Full translation

Features

  • ๐ŸŒ Browser Detection - Automatic language detection
  • ๐Ÿช Persistent Preferences - Cookie-based language memory
  • ๐Ÿ”„ Dynamic Switching - Real-time language changes
  • ๐Ÿš€ SEO Optimization - Language-specific meta tags and URLs

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

How to Contribute

  1. Fork the Repository

    git clone https://github.com/somethingnew71/classicminidiy.git
  2. Create a Feature Branch

    git checkout -b feature/AmazingFeature
  3. Make Your Changes

    • Follow the existing code style and conventions
    • Add tests for new functionality
    • Update documentation as needed
  4. Test Your Changes

    npm run build
    npm run format
  5. Commit Your Changes

    git commit -m 'Add some AmazingFeature'
  6. Push to Your Branch

    git push origin feature/AmazingFeature
  7. Open a Pull Request

Contribution Guidelines

  • ๐ŸŽฏ Focus on Classic Mini Content - Ensure contributions are relevant to Classic Mini enthusiasts
  • ๐Ÿ“ Document Changes - Update relevant documentation and comments
  • ๐Ÿงช Test Thoroughly - Verify functionality across different devices and browsers
  • ๐ŸŽจ Follow Design Patterns - Maintain consistency with existing UI/UX patterns
  • ๐ŸŒ Consider Internationalization - Add translation keys for new text content

Top Contributors

(back to top)

Deployment

Production Deployment

The application is optimized for deployment on Vercel with the following configuration:

# Build the application
npm run build

# Preview the production build locally
npm run start

Environment Requirements

  • Node.js v22.12.0+
  • Build Command: nuxi build
  • Output Directory: .nuxt/dist
  • Environment Variables: See Environment Setup

Performance Optimizations

  • ๐Ÿš€ Server-Side Rendering - Pre-rendered pages for optimal SEO
  • ๐Ÿ“ฆ Code Splitting - Optimized bundle sizes with manual chunks
  • ๐Ÿ–ผ๏ธ Image Optimization - WebP and AVIF formats with responsive sizing
  • ๐Ÿ’พ Caching Strategies - CDN and service worker caching
  • โšก Edge Functions - Global distribution for API routes

(back to top)

Support

Community Support

Financial Support

Help keep the servers running and the project growing:

Your support helps cover:

  • ๐Ÿ–ฅ๏ธ Server hosting costs
  • ๐Ÿ—„๏ธ Database and storage fees
  • ๐Ÿ”„ CDN and bandwidth costs
  • ๐Ÿ› ๏ธ Development tools and services

Related Projects

Credits & Acknowledgments

This software uses and builds upon information from the following sources:

Technical Information Sources

  • Seven Mini Parts - SU needle charts and technical specifications
  • MintyLamb - Original needle configurator inspiration
  • MiniColours.co.uk - Color reference database
  • miniweights.co.uk - Vehicle weight specifications (archived)
  • mk1-performance.com - Historical archive content (archived)

Community Contributions

  • Classic Mini Forums - Technical knowledge and specifications
  • User Submissions - Registry entries, wheel photos, and color contributions
  • Community Feedback - Bug reports, feature requests, and improvements

Open Source Libraries

  • Nuxt.js - Vue.js framework
  • TailwindCSS - Utility-first CSS framework
  • Highcharts - Data visualization
  • Fuse.js - Fuzzy search functionality
  • LangChain/LangGraph - AI integration

License

Distributed under the GNU General Public License v3.0.

This ensures that:

  • โœ… The project remains free and open source
  • โœ… Modifications must also be open source
  • โœ… Commercial use is permitted
  • โœ… The project can be freely distributed

See LICENSE file for more information.


Classic Mini DIY - Preserving Classic Mini knowledge for future generations

Made with โค๏ธ by the Classic Mini community

โฌ† Back to top

About

Classic Mini DIY is the best place to find all the reference material, how-to videos, and much much more for your Classic Mini

Topics

Resources

License

Stars

Watchers

Forks

Contributors 4

  •  
  •  
  •  
  •