Our local setup is meant to be one command. From a fresh clone you should be able to run make dev-local and reach a working editor.
Nobody has tested that recently on a machine that is not a maintainer's. First-run friction is the most common reason a new contributor gives up, and we cannot see it from the inside.
What to do
Clone the repository into a new directory. Follow README.md from the top, exactly as written. Change nothing and skip nothing, even where a step looks obvious.
Write down everything that goes wrong or surprises you:
- a command that fails, with its full error output
- a prerequisite the README does not mention
- a step that assumes knowledge you did not have
- a wait long enough that you thought it had hung
- wording that sent you the wrong way
Your operating system, your architecture, your Bun version, and your Docker version all matter. Please include them.
This is useful even if nothing breaks
"I followed the README on Windows with WSL2 and it worked, but step 4 took eleven minutes and I thought it had frozen" is a real finding. Report it.
Done when
You have posted your notes on this issue. Fixing what you found is welcome, and it is not required. Reporting it is the contribution.
Where to ask
Comment here, or join Discord.
Our local setup is meant to be one command. From a fresh clone you should be able to run
make dev-localand reach a working editor.Nobody has tested that recently on a machine that is not a maintainer's. First-run friction is the most common reason a new contributor gives up, and we cannot see it from the inside.
What to do
Clone the repository into a new directory. Follow
README.mdfrom the top, exactly as written. Change nothing and skip nothing, even where a step looks obvious.Write down everything that goes wrong or surprises you:
Your operating system, your architecture, your Bun version, and your Docker version all matter. Please include them.
This is useful even if nothing breaks
"I followed the README on Windows with WSL2 and it worked, but step 4 took eleven minutes and I thought it had frozen" is a real finding. Report it.
Done when
You have posted your notes on this issue. Fixing what you found is welcome, and it is not required. Reporting it is the contribution.
Where to ask
Comment here, or join Discord.