readme update

This commit is contained in:
akdeb 2025-04-23 12:27:29 +01:00
parent 6c44492aea
commit 536665acdd

View file

@ -63,12 +63,7 @@ npm run dev
3. Add your ESP32-S3 Device MAC Address to the [Settings page](http://localhost:3000/home/settings) in the NextJS Frontend. This links your device to your account.
To find your ESP32-S3 Device's MAC Address, build and upload `test/print_mac_address_test.cpp` using PlatformIO.
4. Add your OpenAI API Key in the `server-deno/.env` and `frontend-nextjs/.env.local` file.
```
OPENAI_API_KEY=<your_openai_api_key>
```
5. Start the Deno server. ([See the Deno server README](server-deno/README.md))
4. Start the Deno server. ([See the Deno server README](server-deno/README.md))
```bash
# Navigate to the server directory
cd server-deno
@ -82,13 +77,18 @@ cp .env.example .env
deno run -A --env-file=.env main.ts
```
5. Set up your ESP32 Arduino Client. ([See the ESP32 README](firmware-arduino/README.md)) On PlatformIO, first `Build` the project, then `Upload` the project to your ESP32.
5. Add your OpenAI API Key in the `server-deno/.env` and `frontend-nextjs/.env.local` file.
```
OPENAI_API_KEY=<your_openai_api_key>
```
6. The ESP32 should open an AP `ELATO-DEVICE` to connect to Wifi. Connect to it and go to `http://192.168.4.1` to configure the device wifi.
6. Set up your ESP32 Arduino Client. ([See the ESP32 README](firmware-arduino/README.md)) On PlatformIO, first `Build` the project, then `Upload` the project to your ESP32.
7. Once your Wifi is configured, turn the device off and on again and it should connect to your Wifi and the Deno edge server.
7. The ESP32 should open an AP `ELATO-DEVICE` to connect to Wifi. Connect to it and go to `http://192.168.4.1` to configure the device wifi.
8. Now you can talk to your AI Character!
8. Once your Wifi is configured, turn the device off and on again and it should connect to your Wifi and the Deno edge server.
9. Now you can talk to your AI Character!
## Project Architecture