🧶 Miriam's Crochet Box

A beautiful static website for sharing crochet patterns with video tutorials, built with TypeScript and vanilla web technologies.

Features

• Pattern Library: Browse and view detailed crochet patterns
• Video Tutorials: Each pattern can include YouTube video links
• Pattern Creator: Create and manage your own patterns
• Standardized Symbols: Uses common crochet symbols and abbreviations
• Local Storage: Patterns are saved locally in your browser
• Responsive Design: Works on desktop and mobile devices

Getting Started

For Users

Simply visit the website and start browsing patterns! You can:

• View existing example patterns
• Create your own patterns using the pattern creator
• Watch video tutorials for each pattern
• Export/import your pattern collection

For Developers

1. Clone the repository

   git clone https://github.com/cmollgaard/miriams_croche_bix.git
   cd miriams_croche_bix

2. Install dependencies

   npm install

3. Build the TypeScript

   npm run build

4. Serve locally Open index.html in your browser or use a local server:

   python -m http.server 8000
   # or
   npx serve .

5. Development mode (with auto-rebuild)

   npm run watch

Project Structure

The repository contains:

• Static website files (HTML, CSS, TypeScript)
• Pattern data in JSON format
• Build and deployment configuration
• Utility scripts for pattern management

Pattern Format

Patterns are stored as JSON objects with the following structure:

interface CrochetPattern {
    id: string;
    name: string;
    description: string;
    difficulty: 'beginner' | 'intermediate' | 'advanced';
    videoUrl?: string;
    instructions: string;
    symbols: CrochetSymbol[];
    materials: string[];
    hooks: string[];
    gauge?: string;
    finished_size?: string;
    created_date: string;
    updated_date: string;
}

Standard Crochet Symbols

The app includes these standardized symbols:

• ○ (ch) - Chain
• × (sc) - Single Crochet
• ⫸ (dc) - Double Crochet
• ⟂ (hdc) - Half Double Crochet
• ⊃ (sl st) - Slip Stitch
• ⌒ (tr) - Treble Crochet

Contributing

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Deployment

The website automatically deploys to GitHub Pages when changes are pushed to the main branch.

License

This project is open source. Feel free to use, modify, and distribute as needed.

Future Enhancements

• Pattern search and filtering
• User accounts and cloud storage
• Pattern sharing between users
• Advanced symbol editor
• PDF pattern export
• Stitch counter integration
• Community features and pattern ratings