|
| 1 | +# Shamrock Website |
| 2 | + |
| 3 | +A modern, responsive website for the Shamrock scientific computing framework built with HTML, CSS, and JavaScript. |
| 4 | + |
| 5 | +## 🚀 Features |
| 6 | + |
| 7 | +- **Modern Design**: Clean, professional design with viridis-inspired color palette |
| 8 | +- **Responsive Layout**: Works perfectly on desktop, tablet, and mobile devices |
| 9 | +- **Interactive Elements**: Smooth animations, copy-to-clipboard functionality, and mobile navigation |
| 10 | +- **Fast Loading**: Optimized static files for quick loading times |
| 11 | +- **Accessibility**: Built with accessibility best practices |
| 12 | + |
| 13 | +## 📁 Project Structure |
| 14 | + |
| 15 | +``` |
| 16 | +website-testing/ |
| 17 | +├── index.html # Main HTML file |
| 18 | +├── styles.css # CSS styles with modern design |
| 19 | +├── script.js # JavaScript for interactivity |
| 20 | +├── _static/ # Static assets |
| 21 | +│ ├── logo.png # Shamrock logo |
| 22 | +│ └── no_background_nocolor.png # Shamrock banner |
| 23 | +├── .github/workflows/ # CI/CD configuration |
| 24 | +│ └── upload-page.yml # GitHub Pages deployment |
| 25 | +└── README.md # This file |
| 26 | +``` |
| 27 | + |
| 28 | +## 🎨 Design Features |
| 29 | + |
| 30 | +### Color Palette |
| 31 | +- **Primary Purple**: `#440154` - Main brand color |
| 32 | +- **Secondary Purple**: `#482475` - Secondary brand color |
| 33 | +- **Blue**: `#355f8d` - Accent color |
| 34 | +- **Teal**: `#22a884` - Success/positive color |
| 35 | +- **Green**: `#7ad151` - Highlight color |
| 36 | + |
| 37 | +### Typography |
| 38 | +- **Font Family**: Inter (Google Fonts) |
| 39 | +- **Responsive**: Scales appropriately across devices |
| 40 | +- **Hierarchy**: Clear typographic hierarchy with proper contrast |
| 41 | + |
| 42 | +### Components |
| 43 | +- **Navigation**: Fixed header with mobile hamburger menu |
| 44 | +- **Hero Section**: Eye-catching introduction with call-to-action buttons |
| 45 | +- **Quick Links**: Grid of important links and resources |
| 46 | +- **Features**: Highlighted feature cards with icons |
| 47 | +- **Installation**: Code examples with copy functionality |
| 48 | +- **Documentation**: Links to various documentation resources |
| 49 | +- **Community**: Community links and contribution call-to-action |
| 50 | +- **Footer**: Comprehensive footer with links and social media |
| 51 | + |
| 52 | +## 🛠️ Development |
| 53 | + |
| 54 | +### Local Development |
| 55 | +1. Clone the repository |
| 56 | +2. Open `index.html` in your browser |
| 57 | +3. Make changes to HTML, CSS, or JavaScript files |
| 58 | +4. Refresh browser to see changes |
| 59 | + |
| 60 | +### File Structure |
| 61 | +- **HTML**: Semantic structure with proper accessibility |
| 62 | +- **CSS**: Modern CSS with CSS Grid, Flexbox, and CSS Variables |
| 63 | +- **JavaScript**: Vanilla JS with modern ES6+ features |
| 64 | + |
| 65 | +### Key JavaScript Features |
| 66 | +- Mobile navigation toggle |
| 67 | +- Copy-to-clipboard functionality |
| 68 | +- Smooth scrolling for anchor links |
| 69 | +- Intersection Observer for animations |
| 70 | +- Form validation utilities |
| 71 | + |
| 72 | +## 🚀 Deployment |
| 73 | + |
| 74 | +The website is automatically deployed to GitHub Pages via GitHub Actions. |
| 75 | + |
| 76 | +### CI/CD Pipeline |
| 77 | +1. **Trigger**: Push to main branch or pull request |
| 78 | +2. **Build**: Copy static files to build directory |
| 79 | +3. **Deploy**: Upload to GitHub Pages |
| 80 | +4. **Result**: Website available at `https://shamrock-code.github.io/website-testing` |
| 81 | + |
| 82 | +### Manual Deployment |
| 83 | +If you need to deploy manually: |
| 84 | +1. Run the build script locally |
| 85 | +2. Upload files to your web server |
| 86 | +3. Ensure all assets are accessible |
| 87 | + |
| 88 | +## 📱 Responsive Design |
| 89 | + |
| 90 | +The website is fully responsive with breakpoints at: |
| 91 | +- **Desktop**: 1200px and above |
| 92 | +- **Tablet**: 768px to 1199px |
| 93 | +- **Mobile**: Below 768px |
| 94 | + |
| 95 | +### Mobile Features |
| 96 | +- Hamburger menu navigation |
| 97 | +- Touch-friendly buttons and links |
| 98 | +- Optimized typography for small screens |
| 99 | +- Proper spacing and padding |
| 100 | + |
| 101 | +## 🎯 Performance |
| 102 | + |
| 103 | +### Optimizations |
| 104 | +- **Minimal Dependencies**: Only Font Awesome for icons |
| 105 | +- **Efficient CSS**: CSS Grid and Flexbox for layout |
| 106 | +- **Fast Loading**: Optimized images and minimal JavaScript |
| 107 | +- **Caching**: Static assets can be cached effectively |
| 108 | + |
| 109 | +### Best Practices |
| 110 | +- Semantic HTML structure |
| 111 | +- CSS custom properties for maintainability |
| 112 | +- Progressive enhancement |
| 113 | +- Accessibility compliance |
| 114 | + |
| 115 | +## 🔧 Customization |
| 116 | + |
| 117 | +### Colors |
| 118 | +Update the CSS variables in `styles.css`: |
| 119 | +```css |
| 120 | +:root { |
| 121 | + --primary-purple: #440154; |
| 122 | + --secondary-purple: #482475; |
| 123 | + /* ... other colors */ |
| 124 | +} |
| 125 | +``` |
| 126 | + |
| 127 | +### Content |
| 128 | +- Update `index.html` for content changes |
| 129 | +- Modify `styles.css` for styling changes |
| 130 | +- Edit `script.js` for functionality changes |
| 131 | + |
| 132 | +### Adding New Sections |
| 133 | +1. Add HTML structure to `index.html` |
| 134 | +2. Add corresponding CSS to `styles.css` |
| 135 | +3. Add any JavaScript functionality to `script.js` |
| 136 | + |
| 137 | +## 📄 License |
| 138 | + |
| 139 | +This website is part of the Shamrock project. See the main project repository for license information. |
| 140 | + |
| 141 | +## 🤝 Contributing |
| 142 | + |
| 143 | +1. Fork the repository |
| 144 | +2. Create a feature branch |
| 145 | +3. Make your changes |
| 146 | +4. Test locally |
| 147 | +5. Submit a pull request |
| 148 | + |
| 149 | +## 📞 Support |
| 150 | + |
| 151 | +For questions or issues: |
| 152 | +- Create an issue in the GitHub repository |
| 153 | +- Check the main Shamrock documentation |
| 154 | +- Join the community discussions |
| 155 | + |
| 156 | +--- |
| 157 | + |
| 158 | +Built with ❤️ for the Shamrock community |
0 commit comments