From 121cd1263aba7c08dac9a380acc60f5440c0c05e Mon Sep 17 00:00:00 2001 From: "swyx.io" Date: Wed, 30 Oct 2024 00:23:46 -0700 Subject: [PATCH] Update CONTRIBUTING.md updated to offer a video guide. --- CONTRIBUTING.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2a843aa8..3f2fa765 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ If you're contributing, note that the process is similar to other open source re ## Running the project locally -First, start by installing dependencies +First, start by installing dependencies: 1. node.js [instructions](https://nodejs.org/en/learn/getting-started/how-to-install-nodejs) 2. pnpm [instructions](https://pnpm.io/installation) @@ -56,12 +56,13 @@ POSTHOG_HOST= # set if you'd like to send posthog events like job logs First, install the dependencies using pnpm. ```bash -pnpm install +# cd apps/api # to make sure you're in the right folder +pnpm install # make sure you have pnpm version 9+! ``` ### Running the project -You're going to need to open 3 terminals. +You're going to need to open 3 terminals. Here is [a video guide accurate as of Oct 2024](https://youtu.be/LHqg5QNI4UY). ### Terminal 1 - setting up redis