• 🔐 Secure Authentication: GitHub OAuth integration for safe and easy login
• 📊 Real-time Visualization: Live preview of your current contribution graph
• 🎨 Pattern Designer: Intuitive click-to-design interface for creating custom patterns
• ⚡ Automated Repository Management: Automatic repository creation and commit generation
• 🌍 Global Timezone Support: Works correctly across all timezones
• 📱 Responsive Design: Optimized for desktop and mobile devices

• 🔒 OAuth 2.0: Secure GitHub authentication
• 🏠 Private Repositories: Option to create private pattern repositories
• 🌿 Separate Branch: Creates commits in a dedicated commit-canvas branch
• ✅ Validation: Input validation and error handling
• 🧹 Clean Separation: Doesn't interfere with your existing repositories

• A GitHub account
• Modern web browser (Chrome, Firefox, Safari, Edge)
• Internet connection

1. Visit the Application

   https://commit-canvas.injun.dev
   

2. Authenticate with GitHub

   • Click "Login with GitHub"
   • Authorize the application
   • You'll be redirected back to the canvas

3. Design Your Pattern

   • Click on cells in the contribution graph to create your pattern
   • Use the legend to understand existing vs. new contributions
   • Preview your design in real-time

4. Create Your Repository

   • Enter a unique repository name
   • Click "Create Pattern"
   • Wait for the magic to happen ✨

5. View Your Results

   • Check your GitHub profile
   • Your new pattern will appear in the contribution graph
   • Share your creative commit art with the world!

graph TB
    A[User Browser] -->|OAuth| B[GitHub]
    A -->|HTTPS| C[Commit Canvas Server]
    C -->|GitHub API| B
    C -->|Git Operations| D[Temporary Repository]
    D -->|Push| E[GitHub Repository]
    E -->|Reflects in| F[Contribution Graph]

• Web Server: Gin-based HTTP server handling requests
• Authentication: GitHub OAuth 2.0 flow
• Pattern Engine: Converts UI patterns to commit schedules
• Git Manager: Creates and manages repositories and commits
• Frontend: Interactive contribution graph designer

• This tool creates legitimate commits with real content
• All commits include proper attribution and timestamps
• Repositories are created transparently in your account
• Follows GitHub's guidelines for automated content

• Use meaningful repository names
• Don't create excessive patterns (be considerate)
• Understand that patterns become part of your public profile
• Consider the impact on your contribution statistics

• Patterns may take up to 24 hours to fully appear due to GitHub caching
• Limited to 53 weeks of history (GitHub's standard view)
• Requires public repositories for patterns to be visible in contribution graphs
• Cannot modify existing commits or repositories

• Go 1.23 or higher
• Git
• GitHub OAuth App credentials

1. Clone the repository

   git clone https://github.com/in-jun/commit-canvas.git
   cd commit-canvas

2. Install dependencies

   go mod download

3. Set up environment variables

   export GITHUB_CLIENT_ID="your_github_client_id"
   export GITHUB_CLIENT_SECRET="your_github_client_secret"
   export GITHUB_REDIRECT_URL="http://localhost:8080/callback"
   export SESSION_SECRET="your_random_session_secret"

4. Run the application

   go run main.go

5. Open in browser

   http://localhost:8080
   

# Build the image
docker build -t commit-canvas .

# Run the container
docker run -p 8080:8080 \
  -e GITHUB_CLIENT_ID="your_client_id" \
  -e GITHUB_CLIENT_SECRET="your_client_secret" \
  -e GITHUB_REDIRECT_URL="your_redirect_url" \
  -e SESSION_SECRET="your_session_secret" \
  commit-canvas

• Secure Session Management: HTTP-only cookies with proper security headers
• CSRF Protection: State parameter validation in OAuth flow
• Input Validation: Server-side validation of all user inputs
• Rate Limiting: Protection against abuse (recommended for production)
• Secure Headers: HTTPS enforcement and security headers
• Minimal Permissions: Only requests necessary GitHub permissions

We welcome contributions! Here's how you can help:

• 🐛 Bug Reports: Found an issue? Let us know!
• 💡 Feature Requests: Have an idea? We'd love to hear it!
• 🔧 Code Contributions: Submit pull requests
• 📚 Documentation: Help improve our docs
• 🌍 Translations: Help make the app accessible worldwide

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

• Follow Go best practices and conventions
• Use go fmt for formatting
• Add comments for complex logic
• Include tests for new features

• ✅ MVP Complete: Core functionality implemented
• ✅ Security Audit: Basic security measures in place
• ✅ Mobile Support: Responsive design implemented
• 🚧 Enhanced Patterns: Advanced pattern templates (coming soon)
• 🚧 Pattern Sharing: Community pattern gallery (planned)
• 🚧 Analytics: Pattern performance metrics (planned)

This project is licensed under the MIT License - see the LICENSE file for details.

• GitHub for providing the excellent API and platform
• Go Community for the amazing ecosystem of libraries
• Contributors who have helped improve this project
• Users who create beautiful art with their commits

• 🐛 Bug Reports: Create an issue
• 💡 Feature Requests: Request a feature
• 💬 Questions: Start a discussion
• 📧 Contact: injun0607@naver.com