Chore Readme updates (#3302)

* Readme updates

Added explicit installation instructions to server and frontend README

* Documentation update

* WIP

* WIP

---------

Co-authored-by: Tim O'Farrell <tofarr@Tims-MacBook-Pro-2.local>
This commit is contained in:
tofarr
2024-08-08 16:06:58 -06:00
committed by GitHub
parent 4915168da2
commit 040b9cb75c
2 changed files with 21 additions and 1 deletions

View File

@@ -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:

View File

@@ -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