Skip to content

sea-whale/icon-base

Repository files navigation

IconBase

Nuxt Vue.js Tailwind CSS Docker License

IconBase is a privacy-first, one-page web application that transforms your logo into beautiful, Apple-style (squircle) icons for every platform.

Built with Vue 3 and Nuxt 4, it provides real-time WYSIWYG previews across various operating systems and lets you export a complete set of standard icon assets with a single click.

Read this in Chinese (简体中文)

✨ Features

  • Real-Time OS Previews: Instantly see how your icon looks in:
    • macOS Dock
    • Windows 11 Taskbar
    • iOS & Android Home Screens
    • Browser Tabs (Favicon)
  • 40+ Background Templates: Choose from solid colors, gradients, mesh/grid, glassmorphism, noise patterns, and glowing accents.
  • High Customizability: Fine-tune your icon's padding and corner roundness (border radius) using intuitive sliders.
  • One-Click Universal Export: Automatically generates and zips up:
    • .ico file for legacy Windows support
    • Apple Touch Icon (180x180)
    • Android & PWA standard sizes (192x192, 512x512)
    • Browser favicons (16x16, 32x32)
    • site.webmanifest for PWAs
  • 100% Privacy Preserving: Built entirely with the HTML5 Canvas 2D API. Your images never leave your browser—no server uploads, no data collection.
  • i18n Support: Native support for English and Chinese.

🚀 Tech Stack

📦 Setup & Development

Make sure you have Node.js 20+ and pnpm installed.

# 1. Clone the repository
git clone https://github.com/sea-whale/icon-base.git
cd icon-base

# 2. Install dependencies
pnpm install

# 3. Start the development server
pnpm run dev

Open http://localhost:3000 in your browser.

🐳 Docker Deployment

IconBase includes a multi-stage Dockerfile and a GitHub Actions workflow for automatic container builds.

Run via pre-built image (from GitHub Container Registry)

docker pull ghcr.io/sea-whale/icon-base:latest
docker run -d -p 3000:3000 ghcr.io/sea-whale/icon-base:latest

Build manually

docker build -t icon-base .
docker run -d -p 3000:3000 icon-base

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request or open an issue.

📄 License

This project is licensed under the terms of the LICENSE file included in the repository.

Star History

Star History Chart

About

A free, privacy-first, purely client-side tool to generate and zip multi-platform app icons (iOS, Android, Web) in seconds. Zero server cost.

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages