diff --git a/docs/local-collaboration.md b/docs/local-collaboration.md new file mode 100644 index 0000000000..bedaa1f7f1 --- /dev/null +++ b/docs/local-collaboration.md @@ -0,0 +1,20 @@ +# Local Collaboration + +## Setting up the local collaboration server + +### Setting up for the first time? + +Install [Postgres](https://postgresapp.com) and run it. + +Then, from the root of the repo, run `script/bootstrap`. + +### Have a db that is out of date? / Need to migrate? + +Try `cd crates/collab && cargo run -- migrate` from the root of the repo. + +## Testing collab locally + +1. Run `foreman start` from the root of the repo. +1. In another terminal run `script/start-local-collaboration`. +1. Two copies of Zed will open. Add yourself as a contact in the one that is not you. +1. Start a collaboration session as normal with any open project.