Spaces:
Running
Running
docs: update README with concise project overview
Browse files
README.md
CHANGED
|
@@ -9,42 +9,43 @@ pinned: false
|
|
| 9 |
|
| 10 |
# Reachy Mini Website
|
| 11 |
|
| 12 |
-
|
| 13 |
|
| 14 |
-
|
| 15 |
|
| 16 |
-
|
| 17 |
-
1. Push to this repo
|
| 18 |
-
2. HF builds the Docker image (Node.js + Vite build)
|
| 19 |
-
3. Serves the static site with nginx
|
| 20 |
|
| 21 |
-
##
|
| 22 |
|
| 23 |
```bash
|
| 24 |
-
# Install dependencies
|
| 25 |
yarn install
|
| 26 |
-
|
| 27 |
-
# Start dev server
|
| 28 |
yarn dev
|
| 29 |
-
|
| 30 |
-
# Build for production
|
| 31 |
-
yarn build
|
| 32 |
```
|
| 33 |
|
| 34 |
-
|
|
|
|
|
|
|
| 35 |
|
| 36 |
- **Vite** + **React 19**
|
| 37 |
-
- **MUI (Material-UI)
|
| 38 |
-
- **React Router**
|
| 39 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 40 |
|
| 41 |
-
##
|
| 42 |
|
| 43 |
```
|
| 44 |
src/
|
| 45 |
-
βββ components/
|
| 46 |
-
βββ context/
|
| 47 |
-
βββ pages/
|
| 48 |
-
βββ theme/
|
| 49 |
-
βββ assets/
|
| 50 |
```
|
|
|
|
| 9 |
|
| 10 |
# Reachy Mini Website
|
| 11 |
|
| 12 |
+
Official website for **Reachy Mini** β an expressive companion robot for human interaction, creative coding, and AI experimentation.
|
| 13 |
|
| 14 |
+
π **Live:** [reachy-mini-website.hf.space](https://tfrere-reachy-mini-website-redesign.hf.space)
|
| 15 |
|
| 16 |
+

|
|
|
|
|
|
|
|
|
|
| 17 |
|
| 18 |
+
## Quick Start
|
| 19 |
|
| 20 |
```bash
|
|
|
|
| 21 |
yarn install
|
|
|
|
|
|
|
| 22 |
yarn dev
|
|
|
|
|
|
|
|
|
|
| 23 |
```
|
| 24 |
|
| 25 |
+
Opens at `http://localhost:5173`
|
| 26 |
+
|
| 27 |
+
## Stack
|
| 28 |
|
| 29 |
- **Vite** + **React 19**
|
| 30 |
+
- **MUI** (Material-UI)
|
| 31 |
+
- **React Router** + **React Spring**
|
| 32 |
+
|
| 33 |
+
## Deployment
|
| 34 |
+
|
| 35 |
+
Auto-deploys to Hugging Face Spaces via Docker on push.
|
| 36 |
+
|
| 37 |
+
```bash
|
| 38 |
+
yarn build # Production build
|
| 39 |
+
yarn preview # Preview production build
|
| 40 |
+
```
|
| 41 |
|
| 42 |
+
## Structure
|
| 43 |
|
| 44 |
```
|
| 45 |
src/
|
| 46 |
+
βββ components/ # Reusable UI (Header, Footer, Layout...)
|
| 47 |
+
βββ context/ # AppsContext for app data
|
| 48 |
+
βββ pages/ # Home, Download, Apps, FAQ, Build, Buy, GettingStarted
|
| 49 |
+
βββ theme/ # MUI theme config
|
| 50 |
+
βββ assets/ # Images, illustrations
|
| 51 |
```
|