update docs
This commit is contained in:
parent
07ba7f594f
commit
bb68b68182
3 changed files with 24 additions and 2 deletions
21
docs/Deploy.md
Normal file
21
docs/Deploy.md
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
# Deploying guide
|
||||
|
||||
If you are ready to launch your next AI venture that helps people in a meaningful way, this is the guide for you. And we're here to support you in that journey.
|
||||
|
||||
If you get stuck, join our Discord channel where AI enthusiasts from all around the world gather to discuss new ideas and help solve problems together. This is your invite: https://discord.gg/KJWxDPBRUj
|
||||
|
||||
## How to deploy
|
||||
|
||||
1. Elato consists of 4 main parts: the database hosted on supabase, the frontend that runs with NextJS, the server that runs on Deno edge functions and the firmware the runs on your ESP32 Arduino device.
|
||||
|
||||
2. Setup your Supabase db. Follow the instructions here: [Supabase Setup and Usage Guide](../supabase/README.md)
|
||||
|
||||
3. Setup your NextJS frontend. Follow the instructions here: [NextJS Frontend Setup and Usage Guide](../frontend-nextjs/README.md)
|
||||
|
||||
4. Setup your Deno edge server. Follow the instructions here: [Deno Server Setup and Usage Guide](../server-deno/README.md)
|
||||
|
||||
5. Setup your ESP32 Arduino device. Follow the instructions here: [ESP32 Arduino Device Setup and Usage Guide](../firmware-arduino/README.md)
|
||||
|
||||
6. Putting it all together. Now you should have all the individual parts working together. For a single device, you can do not need to configure any device code settings on Supabase. For multiple devices, refer to the [Multiple Devices](MultipleDevices.md) guide.
|
||||
|
||||
7. For use cases and new ideas, refer to the [Use Cases](Usecases.md) guide.
|
||||
|
|
@ -27,7 +27,8 @@ This directory contains the WebSocket server implementation for Elato AI, built
|
|||
### Production Deployment
|
||||
|
||||
1. **Deploy to Deno Deploy**:
|
||||
- Create an account on [Deno Deploy](https://deno.com/deploy)
|
||||
- Create an account on [Deno Dash Deploy](https://dash.deno.com/account/overview)
|
||||
- Note: Deno Dash is the legacy version of Deno Deploy. Elato is currently using Deno Dash.
|
||||
- Create a new project
|
||||
- Connect your GitHub repository or upload your server code
|
||||
- Deploy to a custom domain (e.g., `your-app.deno.dev`)
|
||||
|
|
|
|||
|
|
@ -64,7 +64,7 @@ View a live chart of the tables and their relationships [here](http://localhost:
|
|||
|
||||
## Deploying to your own supabase instance
|
||||
|
||||
1. Create a new supabase project
|
||||
1. Create a new supabase project on supabase.com
|
||||
2. Copy the supabase url and anon key
|
||||
3. Paste them in the `.env` and `.env.local` file in the root of the project
|
||||
4. Link the project to the new supabase instance: `supabase link --project-ref <project_ref>`
|
||||
|
|
|
|||
Loading…
Reference in a new issue