diff --git a/contents/handbook/engineering/developing-locally.md b/contents/handbook/engineering/developing-locally.md index c4bbb5389b54..d16ac23d0eef 100644 --- a/contents/handbook/engineering/developing-locally.md +++ b/contents/handbook/engineering/developing-locally.md @@ -53,27 +53,7 @@ Windows isn't supported natively. But, Windows users can run a Linux virtual mac In case some steps here have fallen out of date, please tell us about it – feel free to [submit a patch](https://github.com/PostHog/posthog.com/blob/master/contents/handbook/engineering/developing-locally.md)! -## Option 1: Developing with Codespaces - -This is a faster option to get up and running. If you don't want to or can't use Codespaces, continue from the next section. - -1. Create your codespace. -![](https://user-images.githubusercontent.com/890921/231489405-cb2010b4-d9e3-4837-bfdf-b2d4ef5c5d0b.png) -2. Update it to 8-core machine type (the smallest is probably too small to get PostHog running properly). -![](https://user-images.githubusercontent.com/890921/231490278-140f814e-e77b-46d5-9a4f-31c1b1d6956a.png) -3. Open the codespace, using one of the "Open in" options from the list. -4. In the codespace, open a terminal window and run `docker compose -f docker-compose.dev.yml up`. -5. Ensure that you are using the right Node version (`nvm install 22 && nvm use 22`) then, in another terminal, run `pnpm i` (and use the same terminal for the following commands). -6. Then run `uv sync` - - If this doesn't activate your python virtual environment, run `uv venv` (install `uv` following the [uv standalone installer guide](https://docs.astral.sh/uv/getting-started/installation/#standalone-installer) if needed) -7. Install `sqlx-cli` with `cargo install sqlx-cli` (install Cargo following the [Cargo getting started guide](https://doc.rust-lang.org/cargo/getting-started/installation.html) if needed) -8. Now run `DEBUG=1 ./bin/migrate` -9. Install [mprocs](https://github.com/pvolok/mprocs#installation) (`cargo install mprocs`) -10. Run `./bin/start`. -11. Open browser to . -12. To get some practical test data into your brand-new instance of PostHog, run `DEBUG=1 ./manage.py generate_demo_data`. - -## Option 2: Developing locally +## Option 1: Developing locally ### Prerequisites @@ -445,6 +425,27 @@ This is it – you should be seeing the PostHog app at . +12. To get some practical test data into your brand-new instance of PostHog, run `DEBUG=1 ./manage.py generate_demo_data`. + + ## Testing For a PostHog PR to be merged, all tests must be green, and ideally you should be introducing new ones as well – that's why you must be able to run tests with ease.