|
| 1 | +# CodeSphere |
| 2 | + |
| 3 | +> Expert-led online coding classes for students in grades 3-12 |
| 4 | +
|
| 5 | +A static HTML5 website showcasing CodeSphere's online coding education programs. Built with modern web technologies and deployed automatically to GitHub Pages. |
| 6 | + |
| 7 | +## 🚀 Quick Start |
| 8 | + |
| 9 | +No build process or dependencies required! Simply open the site in your browser: |
| 10 | + |
| 11 | +```bash |
| 12 | +# Windows |
| 13 | +start index.html |
| 14 | + |
| 15 | +# macOS/Linux |
| 16 | +open index.html |
| 17 | +``` |
| 18 | + |
| 19 | +## 📋 Table of Contents |
| 20 | + |
| 21 | +- [About](#about) |
| 22 | +- [Technologies](#technologies) |
| 23 | +- [Project Structure](#project-structure) |
| 24 | +- [Development](#development) |
| 25 | +- [Deployment](#deployment) |
| 26 | +- [Customization](#customization) |
| 27 | +- [License](#license) |
| 28 | + |
| 29 | +## 🎯 About |
| 30 | + |
| 31 | +CodeSphere offers comprehensive online coding classes for students in grades 3-12, covering: |
| 32 | +- **Scratch** - Visual programming for beginners |
| 33 | +- **Python** - Foundation programming concepts |
| 34 | +- **Java** - Object-oriented programming |
| 35 | +- **Web Development** - HTML, CSS, JavaScript |
| 36 | + |
| 37 | +This website serves as the primary showcase and information hub for the business. |
| 38 | + |
| 39 | +## 🛠 Technologies |
| 40 | + |
| 41 | +This is a static website built with: |
| 42 | + |
| 43 | +- **HTML5** - Semantic markup |
| 44 | +- **CSS3** - Modern styling with responsive design |
| 45 | +- **JavaScript/jQuery 3.x** - Interactive functionality |
| 46 | +- **Bootstrap 4.5.2** - Responsive grid and components |
| 47 | +- **Owl Carousel** - Course showcase slider |
| 48 | +- **Slick Slider** - Content slider |
| 49 | +- **Lightbox.js** - Image galleries |
| 50 | +- **Magnific Popup** - Video modals |
| 51 | + |
| 52 | +## 📁 Project Structure |
| 53 | + |
| 54 | +``` |
| 55 | +codesphere-web/ |
| 56 | +├── index.html # Main entry point (single-page app) |
| 57 | +├── assets/ |
| 58 | +│ ├── css/ # Stylesheets |
| 59 | +│ │ └── templatemo-grad-school.css # Custom styles |
| 60 | +│ ├── js/ # JavaScript files |
| 61 | +│ │ └── custom.js # jQuery initialization |
| 62 | +│ ├── images/ # Image assets |
| 63 | +│ └── fonts/ # Web fonts |
| 64 | +├── vendor/ # Third-party libraries |
| 65 | +│ ├── bootstrap/ # Bootstrap framework |
| 66 | +│ └── jquery/ # jQuery library |
| 67 | +├── .github/ |
| 68 | +│ └── workflows/ |
| 69 | +│ └── static.yml # GitHub Pages deployment |
| 70 | +├── favicon.ico # Site favicon |
| 71 | +├── site.webmanifest # Web app manifest |
| 72 | +└── CLAUDE.md # AI assistant instructions |
| 73 | +``` |
| 74 | + |
| 75 | +## 💻 Development |
| 76 | + |
| 77 | +### Local Development |
| 78 | + |
| 79 | +No build process needed! The site runs directly in your browser: |
| 80 | + |
| 81 | +1. Clone the repository |
| 82 | +2. Open [index.html](index.html) in any modern web browser |
| 83 | +3. Make changes to HTML, CSS, or JS files |
| 84 | +4. Refresh the browser to see changes |
| 85 | + |
| 86 | +### Making Changes |
| 87 | + |
| 88 | +#### Updating Content |
| 89 | +All content is in [index.html](index.html). Sections are identified by `id` attributes: |
| 90 | +- `#section1` - Main Banner |
| 91 | +- `#section2` - Features |
| 92 | +- `#section3` - Why Choose Us |
| 93 | +- `#section4` - Coming Soon |
| 94 | +- `#section5` - Courses |
| 95 | +- `#section6` - Contact |
| 96 | + |
| 97 | +#### Styling |
| 98 | +Custom styles are in [assets/css/templatemo-grad-school.css](assets/css/templatemo-grad-school.css). |
| 99 | + |
| 100 | +**Responsive breakpoints:** |
| 101 | +- 1200px - Large desktop |
| 102 | +- 1000px - Tablet landscape |
| 103 | +- 750px - Tablet portrait |
| 104 | +- 550px - Mobile landscape |
| 105 | + |
| 106 | +#### Adding Courses |
| 107 | +Find the Owl Carousel section in [index.html](index.html) and duplicate an item block: |
| 108 | + |
| 109 | +```html |
| 110 | +<div class="item"> |
| 111 | + <img src="assets/images/courses-*.jpg" alt="Course"> |
| 112 | + <div class="down-content"> |
| 113 | + <h4>Course Title</h4> |
| 114 | + <p>Course description...</p> |
| 115 | + <!-- Add course details --> |
| 116 | + </div> |
| 117 | +</div> |
| 118 | +``` |
| 119 | + |
| 120 | +#### Changing Colors |
| 121 | +Primary colors in the theme: |
| 122 | +- `#f5a425` - Orange accent |
| 123 | +- `#1e1e1e` - Dark backgrounds |
| 124 | +- `#fff` - Light text/backgrounds |
| 125 | + |
| 126 | +Search and replace these hex values in [assets/css/templatemo-grad-school.css](assets/css/templatemo-grad-school.css). |
| 127 | + |
| 128 | +## 🌐 Deployment |
| 129 | + |
| 130 | +Deployment is **fully automated** via GitHub Actions: |
| 131 | + |
| 132 | +1. **Commit** your changes to the `main` branch |
| 133 | +2. **Push** to GitHub |
| 134 | +3. GitHub Actions automatically deploys to GitHub Pages |
| 135 | +4. Changes are **live within minutes** |
| 136 | + |
| 137 | +The deployment workflow is defined in [.github/workflows/static.yml](.github/workflows/static.yml). |
| 138 | + |
| 139 | +### Manual Deployment Setup |
| 140 | + |
| 141 | +If setting up for the first time: |
| 142 | + |
| 143 | +1. Go to repository **Settings** → **Pages** |
| 144 | +2. Set **Source** to "GitHub Actions" |
| 145 | +3. The workflow will run automatically on next push to `main` |
| 146 | + |
| 147 | +## 🎨 Customization |
| 148 | + |
| 149 | +### Images |
| 150 | +Replace images in [assets/images/](assets/images/): |
| 151 | +- `courses-*.jpg` - Course thumbnails |
| 152 | +- `author-*.png` - Instructor avatars |
| 153 | +- `main-slider-*.jpg` - Hero slider images |
| 154 | +- `course-video.mp4` - Background video |
| 155 | + |
| 156 | +### Navigation |
| 157 | +Edit the `<nav>` menu in [index.html](index.html). Links use smooth-scroll: |
| 158 | + |
| 159 | +```html |
| 160 | +<a href="#section-id">Menu Item</a> |
| 161 | +``` |
| 162 | + |
| 163 | +### Carousels |
| 164 | +Configure Owl Carousel in [assets/js/custom.js](assets/js/custom.js): |
| 165 | + |
| 166 | +```javascript |
| 167 | +$('.owl-carousel').owlCarousel({ |
| 168 | + responsive: { |
| 169 | + 0: { items: 1 }, |
| 170 | + 600: { items: 2 }, |
| 171 | + 1000: { items: 4 } |
| 172 | + } |
| 173 | +}); |
| 174 | +``` |
| 175 | + |
| 176 | +## 📝 Design Principles |
| 177 | + |
| 178 | +1. **Static-Only** - No server-side processing required |
| 179 | +2. **Simple Structure** - Easy to maintain and modify |
| 180 | +3. **Auto-Deploy** - Automatic deployment via GitHub Actions |
| 181 | +4. **Mobile-First** - Fully responsive design |
| 182 | +5. **No Build Process** - Works directly in browser |
| 183 | + |
| 184 | +## 🤝 Contributing |
| 185 | + |
| 186 | +When contributing to this project: |
| 187 | + |
| 188 | +1. Keep all components static (no server-side code) |
| 189 | +2. Test responsiveness across devices |
| 190 | +3. Maintain the educational tone for young students and parents |
| 191 | +4. Follow the existing code style and structure |
| 192 | +5. Update this README if adding new features |
| 193 | + |
| 194 | +## 📄 License |
| 195 | + |
| 196 | +Copyright © 2025 CodeSphere. All rights reserved. |
| 197 | + |
| 198 | +--- |
| 199 | + |
| 200 | +**Founded by Sana Siddiqui** | Expert-led coding education for the next generation |
0 commit comments