diff --git a/README.md b/README.md index 56eceb8..3bc8440 100644 --- a/README.md +++ b/README.md @@ -47,13 +47,19 @@ Control your ESP32 AI device from your phone with the Elato AI webapp. ## 🚀 Quick Start -1. Install [Supabase CLI](https://supabase.com/docs/guides/local-development/cli/getting-started) and set up your Local Supabase Backend. From the root directory, run: +1. **Start Supabase** + +Install [Supabase CLI](https://supabase.com/docs/guides/local-development/cli/getting-started) and set up your Local Supabase Backend. From the root directory, run: ```bash brew install supabase/tap/supabase supabase start # Starts your local Supabase server with the default migrations and seed data. ``` -2. Set up your NextJS Frontend. ([See the Frontend README](frontend-nextjs/README.md)) From the `frontend-nextjs` directory, run the following commands. (**Login creds:** Email: admin@elatoai.com, Password: `admin`) +2. **Set up your NextJS Frontend** + +([See the Frontend README](frontend-nextjs/README.md)) + +From the `frontend-nextjs` directory, run the following commands. (**Login creds:** Email: `admin@elatoai.com`, Password: `admin`) ```bash cd frontend-nextjs npm install @@ -67,7 +73,9 @@ cp .env.example .env.local npm run dev ``` -3. Start the Deno server. ([See the Deno server README](server-deno/README.md)) +3. **Start the Deno server** + +([See the Deno server README](server-deno/README.md)) ```bash # Navigate to the server directory cd server-deno @@ -81,9 +89,15 @@ cp .env.example .env deno run -A --env-file=.env main.ts ``` -4. In `Config.cpp` set `ws_server` and `backend_server` to your local IP address. Run `ifconfig` in your console and find `en0` -> `inet` -> `192.168.1.100` (it may be different for your Wifi network). This tells the ESP32 device to connect to your NextJS frontend and Deno server running on your local machine. All services should be on the same Wifi network. +4. **Setup the ESP32 Device firmware** -5. Build and upload the firmware to your ESP32 device. The ESP32 should open an `ELATO-DEVICE` captive portal to connect to Wifi. Connect to it and go to `http://192.168.4.1` to configure the device wifi. +([See the ESP32 Device README](firmware-arduino/README.md)) + +In `Config.cpp` set `ws_server` and `backend_server` to your local IP address. Run `ifconfig` in your console and find `en0` -> `inet` -> `192.168.1.100` (it may be different for your Wifi network). This tells the ESP32 device to connect to your NextJS frontend and Deno server running on your local machine. All services should be on the same Wifi network. + +5. **Setup the ESP32 Device Wifi** + +Build and upload the firmware to your ESP32 device. The ESP32 should open an `ELATO-DEVICE` captive portal to connect to Wifi. Connect to it and go to `http://192.168.4.1` to configure the device wifi. 6. Once your Wifi credentials are configured, turn the device off and on again and it should connect to your Wifi and your server.