Skip to content

armgit / E2B

Public Imported from GitHub
0

Open-source, secure environment with real-world tools for enterprise-grade agents.

Add instructions for local dev to README; Update env examples

Tomas Valenta98d1541c706f
diff --git a/.env.example b/.env.example
new file mode 100644
index 000000000..c28e4be6f
--- /dev/null
+++ b/.env.example
@@ -0,0 +1,13 @@
+# Keys
+
+# OpenAI
+OPENAI_API_KEY=
+
+# Supabase
+SUPABASE_POSTGRES_POOL_URL=postgresql://postgres:postgres@localhost:54322/postgres
+# Service role key you can get the local Supabase in "service_role key: eyJh......"
+SUPABASE_KEY=
+
+NEXT_PUBLIC_SUPABASE_URL=http://localhost:54321
+# Anonymous key you can get from the local Supabase in - "anon key: eyJh......"
+NEXT_PUBLIC_SUPABASE_ANON_KEY=
diff --git a/README.md b/README.md
index 93c73804b..99263d530 100644
--- a/README.md
+++ b/README.md
@@ -28,3 +28,27 @@ Short-term goals, in no particular order.
- Clean up codebase and provide instructions on how to run it locally
- Set up a website
- Launch the initial version
+
+
+## How to run it locally
+
+### 1. Install deps
+```
+yarn install:all
+```
+
+### 2. Start local Supabase
+```
+yarn supabase start
+```
+
+### 3. Add env vars
+Copy [`.env.example`](.env.example) file to [`.env`](.env) in the top directory and fill the following variables:
+- `OPENAI_API_KEY` - your [OpenAI key](https://platform.openai.com/account/api-keys)
+- `SUPABASE_KEY` - service role key for Supabase that you got from the previous step as "service_role key: eyJh......"
+- `NEXT_PUBLIC_SUPABASE_ANON_KEY` - anonymous key for Supabase that you got from the previous step as "anon key: eyJh......"
+
+### 4. Start the IDE
+```
+yarn dev
+```