1# Zed
2
3[](https://github.com/zed-industries/zed/actions/workflows/ci.yml)
4
5Welcome to Zed, a lightning-fast, collaborative code editor that makes your dreams come true.
6
7## Development tips
8
9### Dependencies
10
11* Install [Postgres.app](https://postgresapp.com) and start it.
12* Install the `LiveKit` server and the `foreman` process supervisor:
13
14 ```
15 brew install livekit
16 brew install foreman
17 ```
18
19* Ensure the Zed.dev website is checked out in a sibling directory and install it's dependencies:
20
21 ```
22 cd ..
23 git clone https://github.com/zed-industries/zed.dev
24 cd zed.dev && npm install
25 npm install -g vercel
26 ```
27
28* Return to Zed project directory and Initialize submodules
29
30 ```
31 cd zed
32 git submodule update --init --recursive
33 ```
34
35* Set up a local `zed` database and seed it with some initial users:
36
37 [Create a personal GitHub token](https://github.com/settings/tokens/new) to run `script/bootstrap` once successfully: the token needs to have an access to private repositories for the script to work (`repo` OAuth scope).
38 Then delete that token.
39
40 ```
41 GITHUB_TOKEN=<$token> script/bootstrap
42 ```
43
44### Testing against locally-running servers
45
46Start the web and collab servers:
47
48```
49foreman start
50```
51
52If you want to run Zed pointed at the local servers, you can run:
53
54```
55script/zed-with-local-servers
56# or...
57script/zed-with-local-servers --release
58```
59
60### Dump element JSON
61
62If you trigger `cmd-alt-i`, Zed will copy a JSON representation of the current window contents to the clipboard. You can paste this in a tool like [DJSON](https://chrome.google.com/webstore/detail/djson-json-viewer-formatt/chaeijjekipecdajnijdldjjipaegdjc?hl=en) to navigate the state of on-screen elements in a structured way.
63
64### Licensing
65
66We use [`cargo-about`](https://github.com/EmbarkStudios/cargo-about) to automatically comply with open source licenses. If CI is failing, check the following:
67
68- Is it showing a `no license specified` error for a crate you've created? If so, add `publish = false` under `[package]` in your crate's Cargo.toml.
69- Is the error `failed to satisfy license requirements` for a dependency? If so, first determine what license the project has and whether this system is sufficient to comply with this license's requirements. If you're unsure, ask a lawyer. Once you've verified that this system is acceptable add the license's SPDX identifier to the `accepted` array in `script/licenses/zed-licenses.toml`.
70- Is `cargo-about` unable to find the license for a dependency? If so, add a clarification field at the end of `script/licenses/zed-licenses.toml`, as specified in the [cargo-about book](https://embarkstudios.github.io/cargo-about/cli/generate/config.html#crate-configuration).
71
72
73### Wasm Plugins
74
75Zed has a Wasm-based plugin runtime which it currently uses to embed plugins. To compile Zed, you'll need to have the `wasm32-wasi` toolchain installed on your system. To install this toolchain, run:
76
77```bash
78rustup target add wasm32-wasi
79```
80
81Plugins can be found in the `plugins` folder in the root. For more information about how plugins work, check the [Plugin Guide](./crates/plugin_runtime/README.md) in `crates/plugin_runtime/README.md`.