From b48a20b93f778db2286785596f1dfe68593053cb Mon Sep 17 00:00:00 2001 From: Matt Aitken Date: Thu, 22 Dec 2022 12:38:57 +0000 Subject: [PATCH] Added an additional section to the development readme --- DEVELOPMENT.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index bf3d139a0..cbc54b5da 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -1,5 +1,33 @@ # Initial setup +## Prerequisites + +### 1. Pulsar requirements + +1. Run `brew install libpulsar` to install the C++ libraries that the pulsar-client depends on + +2. Make sure you have Python installed on your machine by running `which python3` in terminal. + +3. If python isn't found then you should install it: https://www.python.org/downloads/. In a new terminal window run `which python3` again. + +4. Run `npm config set python /the/path/from/the/which/python3/command` inserting the path from step 2 or 3 + +5. Install node-gyp: `npm install -g node-gyp` + +6. Make sure you have the Xcode command line tools installed by running `xcode-select --install` from the terminal. If it says they're already installed then you're set. + +7. Run this in the terminal: + +```sh +export CPLUS_INCLUDE_PATH="$CPLUS_INCLUDE_PATH:$(brew --prefix)/include" +export LIBRARY_PATH="$LIBRARY_PATH:$(brew --prefix)/lib" +export PULSAR_CPP_DIR=/opt/homebrew/Cellar/libpulsar/3.1.0 +``` + +8. Run `pnpm install` in the same terminal window. + +## Building and running the webapp + > **Warning** > All the following commands should be launched from the **monorepo root directory**