Skip to content

thesujalpatel/Gitgenix

Repository files navigation

🎨 Gitgenix - GitHub Contribution Art Creator

Gitgenix Logo

Gitgenix

Transform your GitHub profile into a canvas for beautiful contribution art

Live App License Next.js React TypeScript Tailwind

🎯 Try It Now β€’ πŸ“– User Guide β€’ πŸš€ Quick Start β€’ πŸ“š Docs


✨ What is Gitgenix?

Gitgenix is a powerful, intuitive web application that lets you create stunning pixel art on your GitHub contribution graph. Design patterns, text, shapes, and complex artwork that appears on your GitHub profile, making your coding journey more visually expressive and creative.

🎯 Perfect For

  • Developers who want to personalize their GitHub profiles
  • Creative Coders looking to combine art with programming
  • Job Seekers who want their profiles to stand out
  • Students learning about Git and GitHub
  • Anyone who loves pixel art and wants to have fun with their GitHub activity

πŸš€ Quick Start

⚑ 5-Minute Setup

  1. 🌐 Visit: gitgenix.netlify.app
  2. 🎨 Design: Create your pattern using the visual editor
  3. βš™οΈ Configure: Set your GitHub repository details
  4. πŸ“₯ Generate: Download your custom shell script
  5. πŸƒ Execute: Run the script and watch your art appear!

New to Gitgenix? Check out our Quick Start Guide for a detailed walkthrough!


🌟 Key Features

🎨 Visual Pattern Designer

  • Intuitive Interface: Click-and-drag grid with 5 intensity levels
  • Real-time Preview: See exactly how your pattern will appear on GitHub
  • Mobile Optimized: Full touch support for tablets and phones
  • Smooth Animations: Buttery-smooth interactions with Framer Motion

πŸ“Š Smart Contribution Control

  • Custom Limits: Set minimum (0-100) and maximum (1-1000) daily contributions
  • Intelligent Scaling: Automatic intensity distribution between your limits
  • Profile Matching: Blend your art naturally with existing GitHub activity
  • Flexible Patterns: Create subtle designs or bold, high-contrast artwork

πŸ› οΈ Advanced Script Generation

  • Auto-Repository Detection: Smart detection of existing repositories
  • GitHub CLI Integration: Seamless repository creation with gh command
  • Cross-Platform Scripts: Generated for Windows (PowerShell), macOS, and Linux
  • Error Handling: Built-in validation and fallback mechanisms

🌐 Pattern Sharing & Community

  • Beautiful Share Pages: Optimized UI for sharing your creations
  • JSON Export/Import: Full pattern backup with metadata
  • Social Media Ready: Rich preview cards for social sharing
  • Community Gallery: Browse and share patterns with other creators

πŸ“… Multi-Year Support

  • Expansive Artwork: Create patterns spanning multiple years
  • Cross-Year Copying: Duplicate patterns across different years
  • Timeline Planning: Strategic placement for maximum visibility
  • Complex Animations: Build time-based visual narratives

πŸš€ Performance & Accessibility

  • Lightning Fast: Optimized rendering for complex patterns
  • Responsive Design: Works perfectly on all device sizes
  • Reduced Motion: Respects user accessibility preferences

πŸ› οΈ Technology Stack

Frontend Backend Development Deployment
Next.js 15 Firebase Firestore TypeScript 5 Netlify
React 19 GitHub API ESLint Automatic Builds
Tailwind CSS 3 Node.js Prettier CDN
Framer Motion - VS Code Analytics

πŸ”§ Architecture Highlights

  • Modern React: Latest React 19 with concurrent features
  • Type Safety: Full TypeScript coverage for reliability
  • Performance First: Optimized animations and lazy loading
  • SEO Optimized: Complete sitemap and metadata
  • PWA Ready: Progressive Web App capabilities

πŸ“Έ Screenshots & Demo

🎨 Pattern Designer Interface

Pattern Designer

πŸ“± Mobile Experience

Mobile Experience Mobile Experience Mobile Experience

πŸ”— Pattern Sharing

Pattern Sharing

πŸ“Š Multi-Year View

Multi-Year View

πŸŽ₯ See Live Demo β†’


πŸ“š Complete Documentation

πŸ“– User Documentation

Guide Description Best For
πŸš€ Quick Start 5-minute setup guide New users
πŸ“– User Guide Comprehensive instructions All users
❓ FAQ Common questions & troubleshooting Problem solving

πŸ‘¨β€πŸ’» Developer Documentation

Guide Description Best For
🀝 Contributing How to contribute code Contributors
πŸ”§ Development Local setup & development Developers
πŸ“š Developer Reference API docs & architecture Advanced developers
πŸš€ Deployment Production deployment DevOps

🀝 Contributing

We ❀️ contributions! Gitgenix is built by the community, for the community.

🌟 Ways to Contribute

  • πŸ› Report Bugs: Help us identify and fix issues
  • ✨ Suggest Features: Share your ideas for improvements
  • πŸ“ Improve Docs: Help others understand Gitgenix better
  • πŸ’» Write Code: Implement features and fix bugs
  • 🎨 Design: Enhance UI/UX and accessibility
  • πŸ§ͺ Test: Improve quality and reliability

πŸš€ Quick Contributing Steps

# 1. Fork the repository on GitHub
# 2. Clone your fork
git clone https://github.com/thesujalpatel/gitgenix.git

# 3. Create a feature branch
git checkout -b feature/amazing-feature

# 4. Make your changes and commit
git commit -m 'feat: add amazing feature'

# 5. Push and create a Pull Request
git push origin feature/amazing-feature

First time contributing? Look for issues labeled good first issue

Need help? Check our Contributing Guide or ask in Discussions


πŸ† Community & Recognition

🌟 Contributors

Thanks to all the amazing people who make Gitgenix better!

πŸŽ–οΈ Show Your Support

If Gitgenix helps you create amazing GitHub art:

  • ⭐ Star this repository to show your appreciation
  • πŸ› Report bugs to help improve the app
  • 🎨 Share your creations on social media with #Gitgenix
  • 🀝 Contribute code to make it even better
  • πŸ’ Spread the word to other developers

πŸ“Š Analytics & Tracking

Gitgenix includes a simple session-based analytics system to track user engagement and provide usage statistics. This helps us improve the application and understand how users interact with it.

  • πŸ“ˆ Session Analytics: Track unique visitors and sessions using localStorage
  • πŸ”’ Privacy-Focused: All tracking is done locally without external services
  • πŸ› οΈ Simple Setup: No configuration required - works out of the box
  • πŸ“Š Real-time Stats: View live statistics in the admin dashboard

How It Works

  • Unique Visitors: Tracked using browser localStorage, persisted across sessions
  • Session Tracking: 30-minute session windows for active usage tracking
  • Happy Developers: Calculated automatically based on visitor activity and pattern creation
  • Local Caching: Stats are cached locally for better performance

Features

  • Session-based visitor tracking
  • Real-time stats dashboard
  • Automatic happy developer calculation
  • Local storage for privacy
  • No external dependencies

πŸ“ž Support & Community

πŸ’¬ Get Help

🌐 Connect With Us


πŸ“„ License

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

πŸ”“ What this means:

  • βœ… Commercial use: Use in commercial projects
  • βœ… Modification: Change and adapt the code
  • βœ… Distribution: Share your modified versions
  • βœ… Private use: Use for personal projects
  • ❗ License notice: Include the original license

🎨 Ready to Create Art?

Transform your GitHub profile today!

Try Gitgenix


Built with ❀️ by Sujal Patel and the amazing community

Making GitHub profiles more expressive, one pixel at a time.

🎯 Try Now β€’ πŸ“– Learn More β€’ 🀝 Contribute β€’ πŸ’¬ Discuss


Star ⭐ this repository if you found it helpful!