https://github.com/sh20raj/octopress
Turn your GitHub Issues into a CMS for your blog! 🎉
https://github.com/sh20raj/octopress
blog blogging-platform github github-issue-blog
Last synced: 5 months ago
JSON representation
Turn your GitHub Issues into a CMS for your blog! 🎉
- Host: GitHub
- URL: https://github.com/sh20raj/octopress
- Owner: SH20RAJ
- License: mit
- Created: 2024-12-26T14:26:11.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-03T14:21:27.000Z (about 1 year ago)
- Last Synced: 2025-01-03T14:44:09.572Z (about 1 year ago)
- Topics: blog, blogging-platform, github, github-issue-blog
- Language: JavaScript
- Homepage: https://octopress.netlify.app
- Size: 304 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🐙 OctoPress
Turn your GitHub Issues into a CMS for your blog! 🎉
[](https://visitorbadge.io/status?path=https%3A%2F%2Fgithub.com%2FSH20RAJ%2FOctoPress)
[](https://github.com/SH20RAJ/OctoPress/blob/main/LICENSE)
[](https://github.com/SH20RAJ/OctoPress/stargazers)
[](https://github.com/SH20RAJ/OctoPress/issues)
[](https://github.com/SH20RAJ/OctoPress/network)
[](https://twitter.com/intent/tweet?text=Check%20out%20OctoPress!&url=https%3A%2F%2Fgithub.com%2FSH20RAJ%2FOctoPress)
## 🌟 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**
```bash
git clone https://github.com/SH20RAJ/OctoPress.git
cd OctoPress
```
2. **Install Dependencies**
```bash
npm install
```
3. **Set Up Environment**
Create `.env.local`:
```env
GITHUB_REPO=your-username/your-repo
GITHUB_TOKEN=your_github_token_here
```
4. **Start Development Server**
```bash
npm run dev
```
Visit [INSTALLATION.md](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/](samples/) directory for example posts!
## ⚙️ Configuration
Easy configuration through `app/config.js`:
```javascript
export const siteConfig = {
title: "Your Blog Name",
description: "Your blog description",
// ... more options
}
```
## 🎨 Customization
1. **Theme Settings**
```javascript
theme: {
defaultTheme: 'light', // or 'dark'
colors: {
primary: '#0ea5e9',
secondary: '#64748b',
}
}
```
2. **Feature Toggles**
```javascript
features: {
categories: true,
tags: true,
search: true,
newsletter: false,
comments: true
}
```
## 🚀 Deployment
### Vercel (Recommended)
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FSH20RAJ%2FOctoPress)
### Netlify
[](https://app.netlify.com/start/deploy?repository=https://github.com/SH20RAJ/OctoPress)
## 🤝 Contributing
We love contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
## 📜 License
MIT License - see [LICENSE](LICENSE) for details.
## 👨💻 Author
**Shaswat Raj**
- GitHub: [@sh20raj](https://github.com/sh20raj)
- Twitter: [@sh20raj](https://twitter.com/sh20raj)
---
⭐ If you like OctoPress, give it a star on GitHub! ⭐