Spaces:
Runtime error
Runtime error
Hanzo Dev
commited on
Commit
Β·
7213613
1
Parent(s):
ed6db3d
Add proper YAML frontmatter to README
Browse files
README.md
CHANGED
|
@@ -1,132 +1,40 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
|
| 4 |
-
|
| 5 |
-
|
| 6 |
-
|
| 7 |
-
|
| 8 |
-
|
| 9 |
-
### Deploy to Hanzo Cloud
|
| 10 |
|
| 11 |
-
|
| 12 |
|
| 13 |
-
|
| 14 |
|
| 15 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 16 |
|
| 17 |
-
|
| 18 |
|
| 19 |
-
|
|
|
|
|
|
|
| 20 |
|
| 21 |
-
|
| 22 |
|
| 23 |
```bash
|
| 24 |
-
# Clone this template
|
| 25 |
-
git clone https://github.com/hanzoai/template-ai-chat-interface.git
|
| 26 |
-
cd ai-chat-interface
|
| 27 |
-
|
| 28 |
-
# Install dependencies
|
| 29 |
npm install
|
| 30 |
-
# or
|
| 31 |
-
pnpm install
|
| 32 |
-
|
| 33 |
-
# Start development server
|
| 34 |
npm run dev
|
| 35 |
-
# or
|
| 36 |
-
pnpm dev
|
| 37 |
-
|
| 38 |
-
# Open http://localhost:3000
|
| 39 |
```
|
| 40 |
|
| 41 |
-
##
|
| 42 |
-
|
| 43 |
-
This template includes a built-in publish option for Hugging Face Spaces:
|
| 44 |
-
|
| 45 |
-
1. **Login to Hugging Face** in your terminal:
|
| 46 |
-
```bash
|
| 47 |
-
huggingface-cli login
|
| 48 |
-
```
|
| 49 |
-
|
| 50 |
-
2. **Use the built-in publish command**:
|
| 51 |
-
```bash
|
| 52 |
-
npm run publish-hf
|
| 53 |
-
# or
|
| 54 |
-
pnpm publish-hf
|
| 55 |
-
```
|
| 56 |
-
|
| 57 |
-
This will automatically:
|
| 58 |
-
- Create a new Space in your HF account
|
| 59 |
-
- Configure it for Next.js deployment
|
| 60 |
-
- Push all necessary files
|
| 61 |
-
- Your app will be live at: `https://huggingface.co/spaces/YOUR_USERNAME/ai-chat-interface`
|
| 62 |
-
|
| 63 |
-
3. **Or manually push** to an existing Space:
|
| 64 |
-
```bash
|
| 65 |
-
git remote add hf https://huggingface.co/spaces/YOUR_USERNAME/ai-chat-interface
|
| 66 |
-
git push hf main
|
| 67 |
-
```
|
| 68 |
-
|
| 69 |
-
## π¨ Features
|
| 70 |
|
| 71 |
-
|
| 72 |
-
|
| 73 |
-
- **Markdown Support**: Rich text formatting in messages
|
| 74 |
-
- **Dark Mode**: Built-in dark mode support
|
| 75 |
-
- **TypeScript**: Full type safety
|
| 76 |
-
- **Production Ready**: Optimized for performance
|
| 77 |
-
|
| 78 |
-
## π¦ What's Included
|
| 79 |
-
|
| 80 |
-
- Next.js 14 with App Router
|
| 81 |
-
- React 18 with Server Components
|
| 82 |
-
- TypeScript configuration
|
| 83 |
-
- Tailwind CSS with custom theme
|
| 84 |
-
- ESLint and Prettier configs
|
| 85 |
-
- @hanzo/ui component library
|
| 86 |
-
- Lucide React icons
|
| 87 |
-
- Hugging Face deployment config
|
| 88 |
-
|
| 89 |
-
## π οΈ Customization
|
| 90 |
-
|
| 91 |
-
### Theme Colors
|
| 92 |
-
|
| 93 |
-
Edit `tailwind.config.js` to customize the color scheme:
|
| 94 |
-
|
| 95 |
-
```js
|
| 96 |
-
theme: {
|
| 97 |
-
extend: {
|
| 98 |
-
colors: {
|
| 99 |
-
primary: {
|
| 100 |
-
DEFAULT: "hsl(var(--primary))",
|
| 101 |
-
foreground: "hsl(var(--primary-foreground))",
|
| 102 |
-
},
|
| 103 |
-
// Add your custom colors
|
| 104 |
-
}
|
| 105 |
-
}
|
| 106 |
-
}
|
| 107 |
```
|
| 108 |
|
| 109 |
-
|
| 110 |
-
|
| 111 |
-
All UI components are in `components/ui/`. They're built with:
|
| 112 |
-
- Radix UI primitives for accessibility
|
| 113 |
-
- Tailwind CSS for styling
|
| 114 |
-
- Full TypeScript support
|
| 115 |
-
|
| 116 |
-
## π Documentation
|
| 117 |
-
|
| 118 |
-
- [Hanzo Documentation](https://hanzo.app/docs)
|
| 119 |
-
- [@hanzo/ui Components](https://github.com/hanzoai/ui)
|
| 120 |
-
- [Template Gallery](https://huggingface.co/spaces/hanzo-community/gallery)
|
| 121 |
-
|
| 122 |
-
## π€ Contributing
|
| 123 |
-
|
| 124 |
-
Contributions are welcome! Please feel free to submit a Pull Request.
|
| 125 |
-
|
| 126 |
-
## π License
|
| 127 |
-
|
| 128 |
-
MIT License - see [LICENSE](LICENSE) file for details.
|
| 129 |
-
|
| 130 |
-
---
|
| 131 |
-
|
| 132 |
-
Built with β€οΈ by [Hanzo AI](https://hanzo.ai)
|
|
|
|
| 1 |
+
---
|
| 2 |
+
title: ai-chat
|
| 3 |
+
emoji: π
|
| 4 |
+
colorFrom: gray
|
| 5 |
+
colorTo: gray
|
| 6 |
+
sdk: docker
|
| 7 |
+
pinned: false
|
| 8 |
+
---
|
|
|
|
| 9 |
|
| 10 |
+
# ai-chat Template
|
| 11 |
|
| 12 |
+
A Hanzo template for building modern applications.
|
| 13 |
|
| 14 |
+
## Features
|
| 15 |
+
- Built with @hanzo/ui
|
| 16 |
+
- Fully responsive
|
| 17 |
+
- TypeScript support
|
| 18 |
+
- Tailwind CSS styling
|
| 19 |
+
- shadcn/ui components
|
| 20 |
|
| 21 |
+
## Installation
|
| 22 |
|
| 23 |
+
```bash
|
| 24 |
+
npx create-hanzo-app --template ai-chat
|
| 25 |
+
```
|
| 26 |
|
| 27 |
+
## Development
|
| 28 |
|
| 29 |
```bash
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 30 |
npm install
|
|
|
|
|
|
|
|
|
|
|
|
|
| 31 |
npm run dev
|
|
|
|
|
|
|
|
|
|
|
|
|
| 32 |
```
|
| 33 |
|
| 34 |
+
## Build
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 35 |
|
| 36 |
+
```bash
|
| 37 |
+
npm run build
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 38 |
```
|
| 39 |
|
| 40 |
+
Check out the [Hanzo Template Gallery](https://huggingface.co/spaces/hanzoai/gallery) for more templates.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|