Skip to content

nuwa-protocol/nuwa-client

Repository files navigation

Nuwa AI Readme Background

Nuwa AI Client

A local-first AI chat client implemented for Nuwa AI that enables users to create, share, and interact with Caps.

Caps (i.e. capability) are mini-apps in Nuwa AI, the minimium functional AI unit. Cap is designed to be an abstraction of AI models and agents. Currently it is the composation of Prompt, Model and MCP Servers.

✨ Features

πŸ” Decentralized Identity & Crypto Payment

  • Decentralized Identity: You control your data with DID-based authentication, fully anonymous
  • Crypto Payment: Use cryptos to pay for your day-to-day AI
  • Data Portability: Export and migrate your data anywhere

🎨 Modern User Experience

  • Shadcn UI: Clean, responsive design with dark/light theme support
  • No MCP Configuration: MCPs use DID authentication directly, eliminates the need for user to config

πŸš€ Beta Release

We're excited to announce the Nuwa Client Beta! This release includes:

  • βœ… Core CAP creation and publishing functionality
  • βœ… Web3 wallet integration
  • βœ… Decentralized identity system
  • βœ… MCP server integration
  • βœ… Payment system

πŸ› οΈ Technology Stack

  • Framerwork: React 19, TypeScript, Vite
  • Styling: Tailwind CSS + Shadcn UI
  • State Management: Zustand with persistence
  • Database: Dexie (IndexedDB) for local storage
  • Identity: DID from @nuwa-ai/identity-kit
  • Payment: Payment Channel from @nuwa-ai/payment-kit
  • Cap Integration: Cap integration from @nuwa-ai/cap-kit
  • Code Quality: Biome for linting and formatting

πŸš€ Quick Start

Prerequisites

  • Node.js 18+
  • pnpm (recommended package manager)

Installation

# Clone the repository
git clone https://github.com/nuwa-protocol/nuwa-client.git
cd nuwa-client

# Install dependencies
pnpm install

# Start development server
pnpm dev

Visit http://localhost:5173 to start using Nuwa Client.

πŸ“– Development

Project Structure

src/
β”œβ”€β”€ features/           # Feature-based modules
β”‚   β”œβ”€β”€ auth/          # Authentication
β”‚   β”œβ”€β”€ chat/          # Chat functionality
β”‚   β”œβ”€β”€ cap-studio/    # CAP creation interface
β”‚   β”œβ”€β”€ cap-store/     # CAP marketplace
β”‚   β”œβ”€β”€ settings/      # User preferences
β”‚   β”œβ”€β”€ sidebar/       # Navigation
β”‚   └── wallet/        # Web3 integration
β”œβ”€β”€ shared/            # Shared utilities and components
β”œβ”€β”€ pages/             # Route components
└── layout/            # Layout components

Each feature follows a consistent structure:

  • components - React components
  • hooks - Custom React hooks
  • stores - Zustand state management
  • services - Backend logics
  • types - TypeScript definitions

πŸ“„ License

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

🀝 Contributing

We welcome contributions! Please see our Contributing Guide for details on how to get started.

πŸ†˜ Support

🎯 Roadmap

  • Cap Inline UI Support
  • Cap Artifacts UI Support
  • Multi-Modal Input Support
  • Desktop App with Tauri

Built with ❀️ by the Nuwa team

Ready to experience the future of AI chat? Try Nuwa Client Beta today!

About

AI chat client for Nuwa AI. Beta version launched! πŸš€

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 7

Languages