π Quick Start Guide
Get your zer0-mistakes Jekyll site running in under 5 minutes with our intelligent installation system.
β‘ Fastest Start (1 Command)
For immediate results:
# Create and setup new site
mkdir my-site && cd my-site
curl -fsSL https://raw.githubusercontent.com/bamr87/zer0-mistakes/main/install.sh | bash && docker-compose up
Thatβs it! Your site will be running at http://localhost:4000
π― What You Get
- π€ AI-Powered Setup - Intelligent error detection and automatic fixes
- π³ Docker Environment - Consistent development across all platforms
- π¨ Bootstrap 5.3 - Modern responsive design with dark mode
- π± Mobile-First - Optimized for all devices and screen sizes
- β‘ Live Reload - Changes appear instantly during development
- π‘οΈ Error Recovery - Self-healing installation with detailed diagnostics
π Step-by-Step Installation
Option 1: Automated Setup (Recommended)
For new sites:
# 1. Create project directory
mkdir my-awesome-site && cd my-awesome-site
# 2. Run intelligent installer
curl -fsSL https://raw.githubusercontent.com/bamr87/zer0-mistakes/main/install.sh | bash
# 3. Start development server
docker-compose up
# 4. Open in browser
open http://localhost:4000
Option 2: GitHub Pages Setup
For GitHub Pages hosting:
# 1. Create repository on GitHub
gh repo create my-site --public
# 2. Clone and setup
git clone https://github.com/USERNAME/my-site.git
cd my-site
# 3. Add remote theme to _config.yml
echo "remote_theme: bamr87/zer0-mistakes" > _config.yml
# 4. Enable GitHub Pages in repository settings
Option 3: Local Development
For theme development:
# 1. Fork and clone
gh repo fork bamr87/zer0-mistakes --clone
cd zer0-mistakes
# 2. Start development
docker-compose up
π Comprehensive Setup Guides
ποΈ Essential Setup
Guide | Purpose | Time | Difficulty |
---|---|---|---|
Machine Setup | Install Docker, Git, and platform tools | 10 min | Beginner |
Jekyll Setup | Configure theme and development environment | 5 min | Beginner |
GitHub Setup | Version control and deployment | 10 min | Intermediate |
π Advanced Configuration
Guide | Purpose | Time | Difficulty |
---|---|---|---|
Bootstrap Customization | Modify themes and responsive design | 15 min | Intermediate |
Performance Optimization | Speed up loading and Core Web Vitals | 20 min | Advanced |
Custom Hosting | Deploy to Netlify, Vercel, or custom servers | 15 min | Intermediate |
π§ Development Tools
Tool | Purpose | Setup Time |
---|---|---|
VS Code Extensions | Enhanced Jekyll development | 5 min |
GitHub CLI | Repository management | 5 min |
Docker Desktop | Containerized development | 10 min |
π― Development Workflows
Local Development
# Start development environment
docker-compose up
# Access your site
open http://localhost:4000
Content Creation
# Create new post
bundle exec jekyll post "My New Post"
# Create new page
bundle exec jekyll page "About"
Theme Customization
# Customize layouts and includes
edit _layouts/default.html
edit _includes/header.html
# Modify styles
edit assets/css/custom.css
π§ Quick Troubleshooting
Installation Issues
Problem: Installation fails
# Check Docker is running
docker --version
# Try minimal installation first
curl -fsSL https://raw.githubusercontent.com/bamr87/zer0-mistakes/main/install.sh | bash -s -- --minimal
Problem: Port 4000 in use
# Check what's using the port
lsof -i :4000
# Use different port
docker-compose run -p 4001:4000 jekyll
Problem: Docker platform warnings
# This is normal on Apple Silicon - the site will still work
# The docker-compose.yml already includes platform: linux/amd64
Validation Commands
Test your installation:
# Verify files were installed
ls -la _config.yml docker-compose.yml INSTALLATION.md
# Test Docker configuration
docker-compose config
# Run automated tests
./test/test_installation_complete.sh --verbose
π Need Help?
Resource | Purpose | Response Time |
---|---|---|
GitHub Issues | Bug reports and technical support | 24-48 hours |
Discussions | Community Q&A and feature requests | Community-driven |
Documentation | Comprehensive guides and tutorials | Immediate |
AI Diagnostics | Built-in automated troubleshooting | Immediate |
π Next Steps
π― Immediate Actions:
- Run the one-command installation
- Verify with the validation commands
- Start customizing your site content
π Learn More:
- Follow the essential setup guides
- Explore advanced configuration options
- Join our community discussions
π Deploy:
- Push to GitHub for automatic Pages deployment
- Configure custom domain if needed
- Monitor performance with built-in tools
Ready to build something amazing? Start with the fastest installation above!