🐙 OctoPress

Turn your GitHub Issues into a CMS for your blog! 🎉

🌟 Features

• 🚀 Zero-Config Setup: Get started in minutes with minimal configuration
• 📝 GitHub Issues as CMS: Use GitHub Issues to write and manage your blog posts
• 🎨 Beautiful UI: Modern, responsive design with dark mode support
• 🔍 SEO Optimized: Built-in SEO features for better visibility
• ⚡ Next.js Powered: Fast, server-side rendered pages
• 🏷️ Label Management: Organize posts with GitHub labels
• 🔎 Search & Filter: Find posts easily with built-in search
• 📱 Mobile Friendly: Looks great on all devices
• 🌙 Dark Mode: Built-in dark mode support
• 🔧 Fully Customizable: Easy configuration through a single file

🚀 Quick Start

1. Clone the Repository

   git clone https://github.com/SH20RAJ/OctoPress.git
   cd OctoPress

2. Install Dependencies

   npm install

3. Set Up Environment Create .env.local:

   GITHUB_REPO=your-username/your-repo
   GITHUB_TOKEN=your_github_token_here

4. Start Development Server

   npm run dev

Visit INSTALLATION.md for detailed setup instructions.

📝 Creating Posts

1. Go to your GitHub repository
2. Create a new issue
3. Add required labels:
   • type:post (required)
   • state:published (required)
   • slug:your-post-slug (optional)
   • tag:your-tag (optional)

Check the samples/ directory for example posts!

⚙️ Configuration

Easy configuration through app/config.js:

export const siteConfig = {
  title: "Your Blog Name",
  description: "Your blog description",
  // ... more options
}

🎨 Customization

1. Theme Settings

   theme: {
     defaultTheme: 'light', // or 'dark'
     colors: {
       primary: '#0ea5e9',
       secondary: '#64748b',
     }
   }

2. Feature Toggles

   features: {
     categories: true,
     tags: true,
     search: true,
     newsletter: false,
     comments: true
   }

🚀 Deployment

Vercel (Recommended)

Netlify

🤝 Contributing

We love contributions! Please see our Contributing Guide for details.

📜 License

MIT License - see LICENSE for details.

👨‍💻 Author

Shaswat Raj

• GitHub: @sh20raj
• Twitter: @sh20raj

---

⭐ If you like OctoPress, give it a star on GitHub! ⭐