Logo
GitHub Stats Studio
Back
Nuxt.js Vue.js TypeScript TailwindCss
@GitHub Stats @Visual Editor @Web App
5 days ago

GitHub Stats Studio

A beautiful visual editor for creating stunning GitHub statistics cards with real-time preview and customization options.

โœจ Stats Gallery

โœจ Languages

โœจ About Project

GitHub Stats Studio is a beautiful visual editor for creating stunning GitHub statistics cards with real-time preview and customization options. This modern web application empowers developers to craft personalized GitHub profile stats cards without writing a single line of code. The intuitive interface provides instant visual feedback, allowing users to experiment with various templates, themes, and customization options to create the perfect stats card for their GitHub profile. Built with Nuxt 4 and Vue 3, it delivers a seamless user experience with smooth animations, zoom controls, and one-click URL generation for immediate integration into GitHub README files.

๐Ÿ› ๏ธ Project Tech Stack

  • Core:

    • Nuxt.js v4.1.3
    • Vue v3.5.28
    • TypeScript v5.0
  • UI & Styling:

    • TailwindCSS v4.2.0
    • Custom Icon Components
    • Responsive Design
  • Features & Utilities:

    • Canvas Confetti (Celebrations)
    • Real-time Preview
    • URL Generation
    • Zoom & Pan Controls
  • Development:

    • Prettier
    • PM2 (Ecosystem Config)
    • ESLint

๐ŸŒˆ Project Features

  • ๐ŸŽจ Visual Editor - Intuitive interface for customizing GitHub stats cards
  • ๐Ÿ‘๏ธ Real-time Preview - See your changes instantly with live preview
  • ๐Ÿ–ผ๏ธ Multiple Templates - Choose from various pre-designed templates
  • โšก Customizable Options - Fine-tune every aspect of your stats card
  • ๐Ÿ” Zoom Controls - Zoom in/out and pan for detailed preview
  • ๐Ÿ“‹ One-click Copy - Copy generated URLs with a single click
  • ๐ŸŽ‰ Delightful UX - Smooth animations and confetti celebrations
  • ๐Ÿ“ฑ Responsive Design - Works seamlessly on all devices
  • ๐ŸŽจ Theme System - Multiple beautiful themes to choose from
  • ๐Ÿ”ง Border Styles - Customize borders, frames, and decorative elements

๐Ÿ’ป Installation & Setup

Prerequisites

  • Node.js 18.x or higher
  • npm, pnpm, yarn, or bun

Installation

  1. Clone the repository:
bash
git clone https://github.com/pphatdev/studio.git
cd studio
  1. Install dependencies:
bash
# npm
npm install

# pnpm
pnpm install

# yarn
yarn install

# bun
bun install

Development Server

Start the development server on http://localhost:3000:

bash
# npm
npm run dev

# pnpm
pnpm dev

# yarn
yarn dev

# bun
bun run dev

Production Build

Build the application for production:

bash
# npm
npm run build

# pnpm
pnpm build

# yarn
yarn build

# bun
bun run build

Locally preview production build:

bash
# npm
npm run preview

# pnpm
pnpm preview

# yarn
yarn preview

# bun
bun run preview

๐Ÿ“ Project Structure

code
studio.pphat.top/
โ”œโ”€โ”€ app/
โ”‚   โ”œโ”€โ”€ assets/
โ”‚   โ”‚   โ””โ”€โ”€ css/           # Global styles
โ”‚   โ”œโ”€โ”€ components/
โ”‚   โ”‚   โ”œโ”€โ”€ icons/         # Icon components
โ”‚   โ”‚   โ”œโ”€โ”€ sidebar/       # Sidebar components
โ”‚   โ”‚   โ””โ”€โ”€ studio/        # Studio preview components
โ”‚   โ”œโ”€โ”€ composables/
โ”‚   โ”‚   โ””โ”€โ”€ useStats.ts    # Stats management composable
โ”‚   โ”œโ”€โ”€ pages/
โ”‚   โ”‚   โ””โ”€โ”€ index.vue      # Main studio page
โ”‚   โ””โ”€โ”€ utils/
โ”‚       โ”œโ”€โ”€ data.json      # Configuration and templates
โ”‚       โ”œโ”€โ”€ themes.ts      # Theme definitions
โ”‚       โ””โ”€โ”€ utils.ts       # Utility functions
โ”œโ”€โ”€ public/                # Static assets
โ”œโ”€โ”€ nuxt.config.ts         # Nuxt configuration
โ””โ”€โ”€ package.json           # Project dependencies

๐Ÿ“ Available Scripts

  • npm run dev - Start development server
  • npm run build - Build for production
  • npm run generate - Generate static site
  • npm run preview - Preview production build
  • npm run prettier - Format code with Prettier

๐ŸŽฏ How It Works

GitHub Stats Studio provides a visual interface to customize GitHub stats cards:

  1. Enter Username - Input your GitHub username
  2. Choose Template - Select from pre-designed templates (Stats, Default, Radar, etc.)
  3. Customize Options - Adjust colors, themes, borders, and visibility
  4. Real-time Preview - See instant updates with zoom and pan controls
  5. Generate URL - Copy the generated URL for your GitHub README
  6. Celebrate - Enjoy delightful confetti animations on success

๐Ÿ™ Acknowledgments

  • Built with Vue and Nuxt
  • Styled with Tailwind CSS
  • Icons and UI components custom-designed
  • Powered by GitHub Stats API at stats.pphat.top

Demo: studio.pphat.top
API: stats.pphat.top
GitHub: pphatdev/studio