Reachy_Mini / README.md
tfrere's picture
tfrere HF Staff
docs: update README with concise project overview
b99c272
|
raw
history blame
1.07 kB
---
title: Reachy Mini
emoji: πŸ€–
colorFrom: blue
colorTo: purple
sdk: docker
pinned: false
---
# Reachy Mini Website
Official website for **Reachy Mini** β€” an expressive companion robot for human interaction, creative coding, and AI experimentation.
🌐 **Live:** [reachy-mini-website.hf.space](https://tfrere-reachy-mini-website-redesign.hf.space)
![Reachy Mini](public/assets/desktop-app-screenshot.png)
## Quick Start
```bash
yarn install
yarn dev
```
Opens at `http://localhost:5173`
## Stack
- **Vite** + **React 19**
- **MUI** (Material-UI)
- **React Router** + **React Spring**
## Deployment
Auto-deploys to Hugging Face Spaces via Docker on push.
```bash
yarn build # Production build
yarn preview # Preview production build
```
## Structure
```
src/
β”œβ”€β”€ components/ # Reusable UI (Header, Footer, Layout...)
β”œβ”€β”€ context/ # AppsContext for app data
β”œβ”€β”€ pages/ # Home, Download, Apps, FAQ, Build, Buy, GettingStarted
β”œβ”€β”€ theme/ # MUI theme config
└── assets/ # Images, illustrations
```