animal-island-ui README

The project's README from github.com/guokaigdg/animal-island-ui. As one markdown file: README.md.

Animal-Island-UI


animal-island-ui

A React UI component library with a cute style

Stars License: CC BY-NC 4.0 Version
Coverage Tests Components Accessibility

guokaigdg%2Fanimal-island-ui | Trendshift Featured|HelloGitHub

English | 简体中文

Introduction

This project is a lightweight UI component library built with React + TypeScript. It features an original, cozy island-style design language, created for personal front-end technical practice and component development learning.All visual elements, layouts, icons, and animations are independently designed and implemented from scratch.

🚀 Use AI to Generate animal-island-ui Pages (No Coding Needed)

Non-developer and don't want to write code yourself? Use the one-click prompt — no npm, no build step.

4 steps:

  1. Copy the prompt block from docs/one-click-prompt.md.
  2. Paste into any AI tool that can fetch URLs (Cursor / Claude / ChatGPT / Gemini / v0 / Bolt) and send.
  3. The AI asks what page you want — reply in one phrase (e.g. "personal blog", "product list", "FAQ").
  4. Save the index.html it returns and double-click to preview.

Using an AI coding agent (Claude Code / Codex / Cursor)? Install the animal-island-ui-style skill instead:

skills add guokaigdg/animal-island-ui

Installation

npm install animal-island-ui

Quick Start

⚠️ Important: Please make sure to import the styles with import 'animal-island-ui/style', otherwise the components will have no styles or fonts!

import { Button, Card } from 'animal-island-ui';
import 'animal-island-ui/style';

function App() {
    return (
        <div>
            <Button type="primary">Start Adventure</Button>
            <Card color="app-blue">Welcome to the island!</Card>
        </div>
    );
}

Documentation

Routed by audience and scenario (English primary; Chinese mirrors under docs/zh-CN/):

Document Purpose
docs/design-system/ 🎨 Canonical design definition (single source of truth) — tokens, design rules, pixel-exact per-component specs, CSS variable template.
skills/animal-island-ui-style/ 🤖 Installable Agent skill (skills add guokaigdg/animal-island-ui) — React project usage + standalone-HTML generation, with per-component props references.
docs/one-click-prompt.md 🚀 One-click prompt for non-developers — paste one bootstrap prompt, the AI fetches the specs itself and returns a ready index.html.
docs/design-prompts.md Prompts for design/image tools (v0 / Figma AI / Midjourney / DALL-E), linking to the canonical spec files.
docs/development/ Development guide for this repository — structure, component development, coding standards, testing, build contract.
docs/adr/ Architecture decision records.
AGENTS.md Entry point for coding agents working in this repository.
CONTRIBUTING.md Contributing guide.

Local Development

# Clone the repository
git clone https://github.com/guokaigdg/animal-island-ui.git
cd animal-island-ui

# Install dependencies
npm install

# Start Demo development server
npm run dev

# Build component library
npm run build

# Build Demo site
npm run build:demo

Notes

Contact

For any questions or copyright-related communications, please contact via Issue or email.

Keep the Island Running

If this project has been helpful to you, consider buying the developer's cat a can of tuna — meowsters are the real fuel that keeps the island running.

Sponsor this Island

License

Creative Commons Attribution-NonCommercial 4.0 International (CC BY-NC 4.0) — see the LICENSE file for the full text.

animal-island-ui (guokaigdg/animal-island-ui)

Searching Database…

What is this?Animal-Island-UI is a lightweight React UI component library with an original 'island' style design language — custom icons, layouts and animations made for personal front-end practice.
Is it a full design system framework or just a component library?It's a React + TypeScript component library you import into existing projects, not a standalone app or framework; it ships with a separate design-system docs folder defining tokens and per-component specs.
How do I add it to my React project?Install it from npm and make sure to also import the stylesheet, e.g. import 'animal-island-ui/style', otherwise components render without styling or fonts.
What do I need before using it?You need a React + TypeScript project with Node.js 18 or newer; the library also pulls in the naive-icons package for its icon set.
Can I use this in a commercial product?No. Commercial use, resale, or profit-making use is explicitly prohibited — it's licensed for personal learning, research, and non-commercial demonstration only.
Who is this library meant for?Hobbyist and learning-focused front-end developers who want a cute, ready-made component set for personal projects, portfolios, or study — not teams building commercial products.
Can I generate a page without writing any code?Yes — paste the bootstrap prompt from docs/one-click-prompt.md into an AI tool like Cursor, Claude, ChatGPT, Gemini, v0 or Bolt, tell it what page you want, and it returns a ready index.html you can double-click to preview.
Does it integrate with coding agents like Claude Code or Codex?Yes, there's an installable agent skill ('skills add guokaigdg/animal-island-ui') that gives agents like Claude Code, Codex, and Cursor direct access to the component props and design specs.
Why is commercial use banned?The author built this as a personal practice project with fully original hand-made icons and animations, and uses CC BY-NC 4.0 specifically to keep it out of commercial/enterprise use.
Creator
guokaigdg
Size
13.9 MB
Stars
5K
Age
6mo
Commits · 90 Days