From 31fa7ca90cdf2470381ccd7f1623b4b2fc78f41a Mon Sep 17 00:00:00 2001 From: Max Brunsfeld Date: Thu, 27 Oct 2022 13:24:35 -0700 Subject: [PATCH] Add livekit to the Procfile, update the README --- Procfile | 1 + README.md | 45 ++++++++++++++++++++++++++------------------- 2 files changed, 27 insertions(+), 19 deletions(-) diff --git a/Procfile b/Procfile index d5db6fbd68..fcc03f55dc 100644 --- a/Procfile +++ b/Procfile @@ -1,2 +1,3 @@ web: cd ../zed.dev && PORT=3000 npx vercel dev collab: cd crates/collab && cargo run serve +livekit: livekit-server --dev \ No newline at end of file diff --git a/README.md b/README.md index 83a249a4fa..9153d12bbb 100644 --- a/README.md +++ b/README.md @@ -6,36 +6,43 @@ Welcome to Zed, a lightning-fast, collaborative code editor that makes your drea ## Development tips +### Dependencies + +* Install [Postgres.app](https://postgresapp.com) and start it. +* Install the `LiveKit` server and the `foreman` process supervisor: + + ``` + brew install livekit + brew install foreman + ``` + +* Ensure the Zed.dev website is checked out in a sibling directory: + + ``` + cd .. + git clone https://github.com/zed-industries/zed.dev + ``` + +* Set up a local `zed` database and seed it with some initial users: + + ``` + script/bootstrap + ``` + ### Testing against locally-running servers -Make sure you have `zed.dev` cloned as a sibling to this repo. +Start the web and collab servers: ``` -cd .. -git clone https://github.com/zed-industries/zed.dev -``` - -Make sure your local database is created, migrated, and seeded with initial data. Install [Postgres](https://postgresapp.com), then from the `zed` repository root, run: - -``` -script/sqlx database create -script/sqlx migrate run -script/seed-db -``` - -Run the web frontend and the collaboration server. - -``` -brew install foreman foreman start ``` If you want to run Zed pointed at the local servers, you can run: ``` -script/zed_with_local_servers +script/zed-with-local-servers # or... -script/zed_with_local_servers --release +script/zed-with-local-servers --release ``` ### Dump element JSON