tfrere HF Staff commited on
Commit
b99c272
Β·
1 Parent(s): 9c0ad15

docs: update README with concise project overview

Browse files
Files changed (1) hide show
  1. README.md +24 -23
README.md CHANGED
@@ -9,42 +9,43 @@ pinned: false
9
 
10
  # Reachy Mini Website
11
 
12
- The official website for Reachy Mini - an expressive companion robot designed for human interaction, creative coding, and AI experimentation.
13
 
14
- ## πŸš€ Auto-deploy
15
 
16
- This site builds automatically on Hugging Face Spaces using Docker:
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
- ## πŸ’» Local Development
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
- ## πŸ› οΈ Stack
 
 
35
 
36
  - **Vite** + **React 19**
37
- - **MUI (Material-UI)** for components
38
- - **React Router** for navigation
39
- - **React Spring** for animations
 
 
 
 
 
 
 
 
40
 
41
- ## πŸ“ Structure
42
 
43
  ```
44
  src/
45
- β”œβ”€β”€ components/ # Reusable UI components
46
- β”œβ”€β”€ context/ # React context (AppsContext)
47
- β”œβ”€β”€ pages/ # Page components
48
- β”œβ”€β”€ theme/ # MUI theme configuration
49
- └── assets/ # Images, fonts
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
+ ![Reachy Mini](public/assets/desktop-app-screenshot.png)
 
 
 
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
  ```