From 4546ec66beb577bc5efea01615954d7307d5f90e Mon Sep 17 00:00:00 2001 From: Mike Haggerty Date: Mon, 7 Oct 2024 10:08:58 -0400 Subject: [PATCH 1/5] docs: update readme to include missing steps --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 438dc2631..d4230a29e 100644 --- a/README.md +++ b/README.md @@ -37,9 +37,12 @@ After all this, you'll be able to run through the below steps: You can use the create react app setup in `playground/nextjs` to test posthog-js as an npm module in a Nextjs application. 1. Run `posthog` locally on port 8000 (`DEBUG=1 TEST=1 ./bin/start`). -2. Run `python manage.py setup_dev --no-data` on posthog repo, which sets up a demo account. -3. Copy posthog token found in `http://localhost:8000/project/settings` and then -4. `cd playground/nextjs`and run `NEXT_PUBLIC_POSTHOG_KEY='' pnpm dev` +1. Run `DEBUG=1 ./manage.py generate_demo_data` on posthog repo, which sets up a demo account. +1. Copy posthog token found in `http://localhost:8000/project/settings` and save it for the last step +1. `cd playground/nextjs` +1. Run `pnpm i` to install dependencies +1. Run `pnpm run build-posthog-js` to build `posthog-js` locally +1. Run `NEXT_PUBLIC_POSTHOG_KEY='' NEXT_PUBLIC_POSTHOG_HOST='http://localhost:8000' pnpm dev` to start the application ### Tiers of testing @@ -100,4 +103,4 @@ Only one person is set as a collaborator on NPM, so they're the only person that Use the "release alpha" label on your PR to have an alpha version published automatically. This automation currently doesn't check whether an alpha exists for the version it will try to publish. If you need to publish two alphas from one PR you'll need to fix that -Remember that these versions are public and folk might use them, so make sure they're not _too_ alpha 🙈 \ No newline at end of file +Remember that these versions are public and folk might use them, so make sure they're not _too_ alpha 🙈 From bded081ba20e7eeb34e168b31482a5b2f9271ee2 Mon Sep 17 00:00:00 2001 From: Mike Haggerty Date: Mon, 7 Oct 2024 10:09:43 -0400 Subject: [PATCH 2/5] Update README.md From 604a9bdb4227c328226cdd4022c485823513639c Mon Sep 17 00:00:00 2001 From: Mike Haggerty Date: Mon, 7 Oct 2024 10:19:46 -0400 Subject: [PATCH 3/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d4230a29e..03b762fe9 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ You can use the create react app setup in `playground/nextjs` to test posthog-js 1. Run `posthog` locally on port 8000 (`DEBUG=1 TEST=1 ./bin/start`). 1. Run `DEBUG=1 ./manage.py generate_demo_data` on posthog repo, which sets up a demo account. -1. Copy posthog token found in `http://localhost:8000/project/settings` and save it for the last step +1. Copy Project API key found in `http://localhost:8000/project/settings` and save it for the last step 1. `cd playground/nextjs` 1. Run `pnpm i` to install dependencies 1. Run `pnpm run build-posthog-js` to build `posthog-js` locally From cf9045d980e15ac18c3ec51b1800f89cca96a755 Mon Sep 17 00:00:00 2001 From: Mike Haggerty Date: Mon, 7 Oct 2024 10:24:13 -0400 Subject: [PATCH 4/5] chore: change demo account command back to previous --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 03b762fe9..51fc0c120 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ After all this, you'll be able to run through the below steps: You can use the create react app setup in `playground/nextjs` to test posthog-js as an npm module in a Nextjs application. 1. Run `posthog` locally on port 8000 (`DEBUG=1 TEST=1 ./bin/start`). -1. Run `DEBUG=1 ./manage.py generate_demo_data` on posthog repo, which sets up a demo account. +1. Run `python manage.py setup_dev --no-data` on posthog repo, which sets up a demo account. 1. Copy Project API key found in `http://localhost:8000/project/settings` and save it for the last step 1. `cd playground/nextjs` 1. Run `pnpm i` to install dependencies From 5a28f95d3cc74d1084c10701d2c6c029a7b73064 Mon Sep 17 00:00:00 2001 From: Mike Haggerty Date: Mon, 7 Oct 2024 10:27:33 -0400 Subject: [PATCH 5/5] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 51fc0c120..9907a2339 100644 --- a/README.md +++ b/README.md @@ -38,11 +38,11 @@ You can use the create react app setup in `playground/nextjs` to test posthog-js 1. Run `posthog` locally on port 8000 (`DEBUG=1 TEST=1 ./bin/start`). 1. Run `python manage.py setup_dev --no-data` on posthog repo, which sets up a demo account. -1. Copy Project API key found in `http://localhost:8000/project/settings` and save it for the last step -1. `cd playground/nextjs` -1. Run `pnpm i` to install dependencies -1. Run `pnpm run build-posthog-js` to build `posthog-js` locally -1. Run `NEXT_PUBLIC_POSTHOG_KEY='' NEXT_PUBLIC_POSTHOG_HOST='http://localhost:8000' pnpm dev` to start the application +1. Copy Project API key found in `http://localhost:8000/project/settings` and save it for the last step. +1. Run `cd playground/nextjs`. +1. Run `pnpm i` to install dependencies. +1. Run `pnpm run build-posthog-js` to build `posthog-js` locally. +1. Run `NEXT_PUBLIC_POSTHOG_KEY='' NEXT_PUBLIC_POSTHOG_HOST='http://localhost:8000' pnpm dev` to start the application. ### Tiers of testing