Skip to content

Commit 1de78f6

Browse files
authored
Merge pull request #7 from flare-foundation/develop
feat: add manual build instructions
2 parents 422aba7 + 75fe531 commit 1de78f6

File tree

1 file changed

+46
-1
lines changed

1 file changed

+46
-1
lines changed

README.md

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Flare AI Kit template for Social AI Agents.
7878
uv run start-bots
7979
```
8080

81-
### Interact with model
81+
### Build Using Docker (Recommended)
8282

8383
The Docker setup mimics a TEE environment and includes an Nginx server for routing, while Supervisor manages both the backend and frontend services in a single container.
8484

@@ -103,6 +103,51 @@ The Docker setup mimics a TEE environment and includes an Nginx server for routi
103103
3. **Access the Frontend:**
104104
Open your browser and navigate to [http://localhost:80](http://localhost:80) to interact with the tuned model via the Chat UI.
105105

106+
### 🛠 Build Manually
107+
108+
Flare AI Social is composed of a Python-based backend and a JavaScript frontend. Follow these steps for manual setup:
109+
110+
#### Backend Setup
111+
112+
1. **Install Dependencies:**
113+
Use [uv](https://docs.astral.sh/uv/getting-started/installation/) to install backend dependencies:
114+
115+
```bash
116+
uv sync --all-extras
117+
```
118+
119+
2. **Start the Backend:**
120+
The backend runs by default on `0.0.0.0:80`:
121+
122+
```bash
123+
uv run start-backend
124+
```
125+
126+
#### Frontend Setup
127+
128+
1. **Install Dependencies:**
129+
In the `chat-ui/` directory, install the required packages using [npm](https://nodejs.org/en/download):
130+
131+
```bash
132+
cd chat-ui/
133+
npm install
134+
```
135+
136+
2. **Configure the Frontend:**
137+
Update the backend URL in `chat-ui/src/App.js` for testing:
138+
139+
```js
140+
const BACKEND_ROUTE = "http://localhost:8080/api/routes/chat/";
141+
```
142+
143+
> **Note:** Remember to change `BACKEND_ROUTE` back to `'api/routes/chat/'` after testing.
144+
145+
3. **Start the Frontend:**
146+
147+
```bash
148+
npm start
149+
```
150+
106151
## 📁 Repo Structure
107152

108153
```plaintext

0 commit comments

Comments
 (0)