Skip to content

ManagedKube/website-creator-v1

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

18 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Website Creator v1

An AI-driven platform for creating and deploying static websites to GitHub Pages. This repository combines the power of AI agents with modern web development practices to streamline website creation.

Overview

Website Creator v1 is designed to be driven by AI agents that handle both planning and implementation of static websites. The platform leverages GitHub Pages for hosting and GitHub Actions for automated deployment.

Features

  • πŸ€– AI Planning Agent: Gathers requirements and creates comprehensive website plans
  • πŸ› οΈ AI Implementation Agent: Builds and deploys websites based on specifications
  • πŸš€ Automatic Deployment: GitHub Actions workflow for seamless GitHub Pages deployment
  • πŸ“± Responsive Design: Mobile-first approach with modern CSS
  • ⚑ Performance Optimized: Fast loading times and optimized assets
  • β™Ώ Accessible: WCAG 2.1 AA compliance
  • 🎨 Customizable: Easy to modify and extend

Repository Structure

website-creator-v1/
β”œβ”€β”€ .github/
β”‚   β”œβ”€β”€ workflows/
β”‚   β”‚   └── pages.yml              # GitHub Actions deployment workflow
β”‚   └── agents/
β”‚       β”œβ”€β”€ planning-agent.md      # Planning Agent context and instructions
β”‚       └── implementation-agent.md # Implementation Agent context and instructions
β”œβ”€β”€ css/
β”‚   └── style.css                  # Main stylesheet
β”œβ”€β”€ js/
β”‚   └── main.js                    # Main JavaScript file
β”œβ”€β”€ _config.yml                    # Jekyll configuration
β”œβ”€β”€ index.html                     # Homepage
β”œβ”€β”€ .gitignore                     # Git ignore patterns
└── README.md                      # This file

Getting Started

Prerequisites

  • A GitHub account
  • Basic understanding of HTML, CSS, and JavaScript (for customization)
  • GitHub Pages enabled in repository settings

Setup GitHub Pages

  1. Go to your repository settings
  2. Navigate to "Pages" section
  3. Under "Source", select "GitHub Actions"
  4. The site will automatically deploy when you push to the main/master branch

Local Development

To view the site locally:

# Clone the repository
git clone https://github.com/ManagedKube/website-creator-v1.git
cd website-creator-v1

# Open index.html in your browser
open index.html
# or
python3 -m http.server 8000
# Then visit http://localhost:8000

Using with Jekyll (Optional)

If you want to use Jekyll's features locally:

# Install Jekyll (requires Ruby)
gem install bundler jekyll

# Serve the site
jekyll serve

# Visit http://localhost:4000

AI Agent Workflow

Planning Phase

The Planning Agent (.github/agents/planning-agent.md):

  1. Asks questions about website goals and requirements
  2. Gathers information about content, design, and functionality
  3. Creates a comprehensive plan and specification
  4. Hands off to the Implementation Agent

Implementation Phase

The Implementation Agent (.github/agents/implementation-agent.md):

  1. Receives the detailed plan from the Planning Agent
  2. Creates HTML, CSS, and JavaScript files
  3. Optimizes assets and ensures quality
  4. Deploys to GitHub Pages
  5. Provides documentation and handoff

Customization

Changing Colors

Edit css/style.css and modify the color values:

/* Header gradient */
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);

/* Accent color */
color: #667eea;

Adding New Pages

  1. Create a new HTML file (e.g., about.html)
  2. Use the same structure as index.html
  3. Update navigation links across all pages
  4. Test and deploy

Modifying Content

Edit index.html to change the content, headings, and structure.

Deployment

Automatic Deployment

Every push to the main/master branch triggers:

  1. GitHub Actions workflow (.github/workflows/pages.yml)
  2. Jekyll build process
  3. Deployment to GitHub Pages
  4. Site available at https://<username>.github.io/<repository>/

Manual Deployment

You can also trigger deployment manually:

  1. Go to "Actions" tab in GitHub
  2. Select "Deploy to GitHub Pages" workflow
  3. Click "Run workflow"

Best Practices

For Content Updates

  • Keep commits focused and atomic
  • Write clear commit messages
  • Test changes locally before pushing
  • Review the live site after deployment

For Development

  • Follow semantic HTML practices
  • Maintain responsive design
  • Optimize images before adding
  • Test across different browsers and devices
  • Keep dependencies minimal

For AI Agents

  • Provide clear, detailed requirements to Planning Agent
  • Review and approve plans before implementation
  • Test implemented features thoroughly
  • Keep agent context files updated

Contributing

When contributing to this project:

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Test thoroughly
  5. Submit a pull request

Troubleshooting

Site Not Deploying

  1. Check GitHub Actions logs in the "Actions" tab
  2. Verify GitHub Pages is enabled in settings
  3. Ensure _config.yml has correct baseurl
  4. Check for syntax errors in HTML/CSS/JS

Styles Not Loading

  1. Verify file paths are correct
  2. Check browser console for errors
  3. Ensure CSS file is properly linked in HTML
  4. Clear browser cache

404 Errors

  1. Check file paths match exactly (case-sensitive)
  2. Verify baseurl in _config.yml
  3. Ensure files are committed to the repository

Resources

License

This project is open source and available under the MIT License.

Support

For issues, questions, or contributions, please use the GitHub Issues page.

About

Helps to create static websites

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •