|
| 1 | +# CLAUDE.md |
| 2 | + |
| 3 | +This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. |
| 4 | + |
| 5 | +## Project Overview |
| 6 | + |
| 7 | +This is a static HTML5 website for **CodeSphere**, an online coding classes business serving students in grades 3-12. The site is deployed to GitHub Pages and serves as a showcase for the business. It's a single-page application with no backend server or build process required. |
| 8 | + |
| 9 | +**Technologies**: HTML5, CSS3, jQuery 3.x, Bootstrap 4.5.2, Owl Carousel, Slick Slider, Lightbox.js, Magnific Popup |
| 10 | + |
| 11 | +**Important**: This project uses only statically-renderable components to maintain simplicity and compatibility with GitHub Pages static hosting. |
| 12 | + |
| 13 | +## Development Commands |
| 14 | + |
| 15 | +### Local Development |
| 16 | +```bash |
| 17 | +# Open the site directly in a browser |
| 18 | +start index.html |
| 19 | +# OR on Mac/Linux |
| 20 | +open index.html |
| 21 | +``` |
| 22 | + |
| 23 | +No build process, package installation, or development server is required. Simply open `index.html` in a browser. |
| 24 | + |
| 25 | +### Deployment |
| 26 | +Deployment is fully automated via GitHub Actions ([.github/workflows/static.yml](.github/workflows/static.yml)): |
| 27 | +- **Automatic**: Any commit to `main` branch triggers the GitHub Action workflow |
| 28 | +- **Immediate**: Changes are deployed automatically to GitHub Pages |
| 29 | +- **No manual steps**: Simply commit your changes and the action handles deployment |
| 30 | + |
| 31 | +## Architecture |
| 32 | + |
| 33 | +### Design Principles |
| 34 | +1. **Static-Only**: All components must be statically renderable (no server-side processing) |
| 35 | +2. **Simple Structure**: Project structure is kept intentionally simple for easy maintenance |
| 36 | +3. **Auto-Deploy**: GitHub Actions automatically deploy on commit to main branch |
| 37 | + |
| 38 | +### File Structure |
| 39 | +``` |
| 40 | +├── index.html # Single-page entry point |
| 41 | +├── assets/ |
| 42 | +│ ├── css/ # All stylesheets |
| 43 | +│ │ └── templatemo-grad-school.css # Main custom styles |
| 44 | +│ ├── js/ # JavaScript files |
| 45 | +│ │ └── custom.js # jQuery initialization and custom logic |
| 46 | +│ ├── images/ # All image assets |
| 47 | +│ └── fonts/ # Web fonts (FontAwesome, Flaticon) |
| 48 | +├── vendor/ # Third-party libraries (Bootstrap, jQuery) |
| 49 | +└── .github/workflows/ # GitHub Actions for automated deployment |
| 50 | + └── static.yml # Deployment workflow |
| 51 | +``` |
| 52 | + |
| 53 | +### JavaScript Architecture |
| 54 | +All JavaScript is loaded in this order (defined in `index.html`): |
| 55 | +1. **jQuery** - Core DOM manipulation library |
| 56 | +2. **Bootstrap JS** - Modal and dropdown functionality |
| 57 | +3. **Isotope** - Layout and filtering |
| 58 | +4. **Owl Carousel** - Responsive carousel for courses |
| 59 | +5. **Lightbox** - Image gallery functionality |
| 60 | +6. **jQuery UI Tabs** - Tabbed content sections |
| 61 | +7. **Video.js** - Video popup functionality |
| 62 | +8. **Slick Slider** - Content slider |
| 63 | +9. **custom.js** - Custom initialization code (runs on document ready) |
| 64 | + |
| 65 | +### CSS Loading Order |
| 66 | +1. Bootstrap base styles |
| 67 | +2. FontAwesome icons |
| 68 | +3. Plugin-specific CSS (owl, lightbox, flex-slider) |
| 69 | +4. `templatemo-grad-school.css` - Custom styles (loads last to override) |
| 70 | + |
| 71 | +### Responsive Breakpoints |
| 72 | +The main stylesheet uses these breakpoints (in `assets/css/templatemo-grad-school.css`): |
| 73 | +- 1200px - Large desktop adjustments |
| 74 | +- 1000px - Tablet landscape |
| 75 | +- 750px - Tablet portrait |
| 76 | +- 550px - Mobile landscape |
| 77 | +- 50px - Very small screens |
| 78 | + |
| 79 | +### Single-Page Structure |
| 80 | +The HTML is divided into these main sections (linked via smooth-scroll navigation): |
| 81 | +- **Header** - Fixed navigation menu |
| 82 | +- **Main Banner** - Hero section with video background (`course-video.mp4`) |
| 83 | +- **Features** - Highlighted features grid showcasing CodeSphere's offerings |
| 84 | +- **Why Choose Us** - Tabbed content section (jQuery UI Tabs) |
| 85 | +- **Coming Soon** - Registration section with countdown timer |
| 86 | +- **Courses** - Owl Carousel showcase of coding classes for grades 3-12 |
| 87 | +- **Video Section** - YouTube embed via Magnific Popup |
| 88 | +- **Contact** - Form section (static form - requires backend to function) |
| 89 | +- **Footer** - Links and copyright |
| 90 | + |
| 91 | +## Key Implementation Details |
| 92 | + |
| 93 | +### Adding/Modifying Sections |
| 94 | +All content is in `index.html`. To modify a section: |
| 95 | +1. Find the section by its `id` attribute (e.g., `<section id="features">`) |
| 96 | +2. Edit the HTML directly |
| 97 | +3. Corresponding styles are in `assets/css/templatemo-grad-school.css` under section-specific classes |
| 98 | + |
| 99 | +### Carousel Configuration |
| 100 | +The Owl Carousel is initialized in `assets/js/custom.js`: |
| 101 | +```javascript |
| 102 | +$('.owl-carousel').owlCarousel({ |
| 103 | + responsive: { |
| 104 | + 0: { items: 1 }, |
| 105 | + 600: { items: 2 }, |
| 106 | + 1000: { items: 4 }, |
| 107 | + 1200: { items: 5 } |
| 108 | + } |
| 109 | +}); |
| 110 | +``` |
| 111 | + |
| 112 | +Modify this configuration to change responsive behavior. |
| 113 | + |
| 114 | +### Video Background |
| 115 | +The hero section uses `assets/images/course-video.mp4` as a background video. Replace this file to change the background video (keep the same filename or update the `<source>` tag in `index.html`). |
| 116 | + |
| 117 | +### Form Handling |
| 118 | +The contact form in `index.html` is currently HTML-only. To make it functional: |
| 119 | +1. Add a backend endpoint (not included in this static site) |
| 120 | +2. Update the form `action` attribute |
| 121 | +3. Add JavaScript validation in `custom.js` |
| 122 | + |
| 123 | +### Image Assets |
| 124 | +All images are in `assets/images/`: |
| 125 | +- **Course images**: `courses-*.jpg` (5 files) |
| 126 | +- **Instructor avatars**: `author-*.png` (5 files) |
| 127 | +- **Feature images**: `choose-us-image-*.png` (3 files) |
| 128 | +- **Slider images**: `main-slider-*.jpg` (3 files) |
| 129 | +- **Background images**: `*-bg.jpg` files |
| 130 | + |
| 131 | +Replace these files to customize visuals (maintain filenames or update references in HTML/CSS). |
| 132 | + |
| 133 | +## Common Modifications |
| 134 | + |
| 135 | +### Changing Colors/Branding |
| 136 | +Primary color scheme is defined in `assets/css/templatemo-grad-school.css`. Search for hex color values like: |
| 137 | +- `#f5a425` - Orange accent color |
| 138 | +- `#1e1e1e` - Dark backgrounds |
| 139 | +- `#fff` - White text/backgrounds |
| 140 | + |
| 141 | +### Adding New Courses |
| 142 | +To add new CodeSphere coding classes, in [index.html](index.html), find the `<div class="owl-carousel">` section and duplicate an `<div class="item">` block. Update: |
| 143 | +- Image source (`<img src="assets/images/courses-*.jpg">`) |
| 144 | +- Instructor avatar (`<img src="assets/images/author-*.png">`) |
| 145 | +- Course title, description, grade level, and metadata |
| 146 | + |
| 147 | +### Updating Navigation |
| 148 | +Edit the `<nav>` element in `index.html`. Each menu item uses smooth-scroll linking: |
| 149 | +```html |
| 150 | +<a href="#section-id">Menu Item</a> |
| 151 | +``` |
| 152 | +The `#section-id` must match a section's `id` attribute on the page. |
| 153 | + |
| 154 | +## GitHub Pages Deployment |
| 155 | + |
| 156 | +The CodeSphere website is automatically deployed via [.github/workflows/static.yml](.github/workflows/static.yml): |
| 157 | +- **Trigger**: Any push/commit to `main` branch |
| 158 | +- **Permissions**: Requires Pages and id-token write permissions |
| 159 | +- **Artifacts**: Uploads entire repository root |
| 160 | +- **URL**: Auto-configured by GitHub Pages settings |
| 161 | +- **Workflow**: Fully automated - just commit your changes and they'll be live within minutes |
| 162 | + |
| 163 | +To modify deployment behavior, edit the workflow file or GitHub repository settings. |
| 164 | + |
| 165 | +## CodeSphere Business Context |
| 166 | + |
| 167 | +This website showcases CodeSphere's online coding classes for students in grades 3-12. When making changes: |
| 168 | +- Keep the focus on education and coding for young students |
| 169 | +- Ensure all components remain static and simple |
| 170 | +- Remember that content should appeal to both students and parents |
| 171 | +- Maintain the professional yet approachable tone suitable for an educational business |
0 commit comments