فهرست منبع

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>
tofarr 1 سال پیش
والد
کامیت
040b9cb75c
2فایلهای تغییر یافته به همراه21 افزوده شده و 1 حذف شده
  1. 6 0
      frontend/README.md
  2. 15 1
      opendevin/server/README.md

+ 6 - 0
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:

+ 15 - 1
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