Update readme for easier local setup

README.md

@@ -1,9 +1,29 @@
 # Agentboard
+Agentboard is a project that allows you to use Open Interpreter in your browser.
 
-## How to run repo
+It's made with [E2B's sandbox](https://e2b.dev). Inside the sandbox, we use [Open Interpreter](https://openinterpreter.com/) to run code.
 
-1. Make sure you have the correct `.env` file in both `backend` and `frontend` folders.
-2. Run `make run`
-3. Once you want to stop the services, run `make stop`
+## Free hosted version
+[agentboard.dev](https://agentboard.dev)
+
+
+## How to run app locally
+
+**Requirements**
+- Supabase project
+  - Your Supabase project needs to have enabled [GitHub and Google auth providers](./supabase-auth.png)
+- [Poetry](https://python-poetry.org/)
+
+### Steps
+**Frontend**
+1. Copy `frontend/.env.example` to `frontend/.env` and set the correct env vars
+1. Go to `frontend`
+1. Install dependencies `pnpm i`
+1. Start frontend `pnpm dev`
+
+**Backend**
+1. Copy `backend/.env.example` to `backend/.env` and set the correct env vars
+1. Install dependencies `poetry install`
+1. Active poetry environment `poetry shell`
+1. Start backend `poetry run python backend/main.py`
 
-You can also run each service locally, you can find more information in the README.md file in each service folder.

backend/README.md

@@ -6,4 +6,4 @@ Uses [Open Interpreter](https://github.com/OpenInterpreter/open-interpreter) run
 
 1. Make sure you have the correct `.env` file.
 2. Install the dependencies with `poetry install` (if you don't have poetry, here's an [installation guide](https://python-poetry.org/docs/#installation).
-3. Run the backend with `uvicorn main:app --reload --port 8080`.
+3. Run the backend with `uvicorn server:app --reload --port 8080`.

backend/pyproject.toml

@@ -1,5 +1,5 @@
 [tool.poetry]
-name = "agentboard-backed"
+name = "agentboard-backend"
 version = "0.1.0"
 description = ""
 authors = ["Jakub Novak <[email protected]>"]
@@ -23,4 +23,3 @@ black = "^24.3.0"
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
-

frontend/.env.template

@@ -4,7 +4,7 @@ NEXT_PUBLIC_SUPABASE_ANON_KEY=
 E2B_API_KEY=
 
 # Required for production
-NEXT_PUBLIC_AGENTBOARD_API_URL
+NEXT_PUBLIC_AGENTBOARD_API_URL=
 
 # Optional
 NEXT_PUBLIC_POSTHOG_KEY=