diff --git a/frontend/README.md b/frontend/README.md index 01530e63e2..4e6b58c79f 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -1,5 +1,11 @@ # Getting Started with the OpenDevin Frontend +The frontend code can be run against the docker image defined in the [Main README](../README.md) as a backend + +## Prerequisites + +A recent version of NodeJS / NPM (`brew install node`) + ## Available Scripts In the project directory, you can run: diff --git a/opendevin/server/README.md b/opendevin/server/README.md index fa4d6249e6..991f0fe7c0 100644 --- a/opendevin/server/README.md +++ b/opendevin/server/README.md @@ -2,9 +2,23 @@ This is a WebSocket server that executes tasks using an agent. +## Recommended Prerequisites + +- [Initialize the frontend code](../../frontend/README.md) +- Install Python 3.12 (`brew install python` for those using homebrew) +- Install pipx: (`brew install pipx` followed by `pipx ensurepath`) +- Install poetry: (`pipx install poetry`) + ## Install -Follow the instructions in the base README.md to install dependencies and set up. +First build a distribution of the frontend code (From the project root directory): +``` +cd frontend +npm install +npm run build +cd .. +``` +Next run `poetry shell` (So you don't have to repeat `poetry run`) ## Start the Server