Quick Start Guide
Quick Start Guide
🚀 Get Started in 3 Steps
1. Navigate to the website directory
cd website
2. Install dependencies (if you have Ruby/Jekyll working)
bundle install
3. Start the development server
./serve.sh
OR if you prefer manual commands:
bundle exec jekyll serve --livereload
🌐 View Your Site
Open http://localhost:4000 in your browser.
📁 File Structure
website/
├── _config.yml # Jekyll configuration
├── _layouts/
│ └── default.html # Main layout template
├── index.md # Homepage content
├── Gemfile # Ruby dependencies
├── serve.sh # Development server script
├── deploy.sh # Deployment script
└── README.md # Full documentation
🚀 Deploy to GitHub Pages
Option 1: New Repository
- Create a new GitHub repository
- Copy all files from
website/to the new repo - Push to
mainbranch - Enable GitHub Pages in repository settings
Option 2: Same Repository
- Push your changes to GitHub
- Go to repository Settings > Pages
- Set source to
/websitefolder - Your site will be live at
https://yourusername.github.io/barbershop-app
🛠️ Troubleshooting
Ruby/OpenSSL Issues
If you get OpenSSL errors, try:
# Install OpenSSL via Homebrew
brew install openssl
# Reinstall Ruby with OpenSSL support
rvm reinstall ruby-3.0.0 --with-openssl-dir=$(brew --prefix openssl)
Alternative: Use GitHub’s Built-in Jekyll
If local Jekyll doesn’t work, you can:
- Push your files to GitHub
- GitHub will automatically build and serve the Jekyll site
- No local setup required!
📝 Editing Content
- Homepage: Edit
index.md - Styling: Edit
_layouts/default.html - Site settings: Edit
_config.yml - New pages: Create new
.mdfiles in the root
🎨 Customization
The site uses:
- Jekyll for static site generation
- Tailwind CSS for styling
- GitHub Pages for hosting
- Minimal theme as base
All styling is in _layouts/default.html - modify as needed!