Skip to content

pphatdev/studio

Repository files navigation

GitHub Stats Studio

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


Nuxt Vue Tailwind CSS TypeScript

✨ 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

πŸš€ Getting Started

Prerequisites

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

Installation

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

# pnpm
pnpm install

# yarn
yarn install

# bun
bun install

Development Server

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

# npm
npm run dev

# pnpm
pnpm dev

# yarn
yarn dev

# bun
bun run dev

πŸ—οΈ Production

Build the application for production:

# npm
npm run build

# pnpm
pnpm build

# yarn
yarn build

# bun
bun run build

Locally preview production build:

# npm
npm run preview

# pnpm
pnpm preview

# yarn
yarn preview

# bun
bun run preview

πŸ“ Project Structure

studio.stats.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

πŸ› οΈ Tech Stack

  • Framework: Nuxt 4 - The Intuitive Vue Framework
  • UI Library: Vue 3 - The Progressive JavaScript Framework
  • Styling: Tailwind CSS 4 - Utility-first CSS framework
  • Language: TypeScript - JavaScript with syntax for types
  • Effects: canvas-confetti - Confetti celebrations

πŸ“ 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

🀝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

πŸ“„ License

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

πŸ‘€ Author

Sophat LEAT (pphatdev)

πŸ™ Acknowledgments

  • Built with Vue and Nuxt
  • Styled with Tailwind CSS
  • Icons and UI components custom-designed

About

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

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors