From a8af3b2556c1b1a83165ef5f8dad6940e0dc117a Mon Sep 17 00:00:00 2001 From: taea Date: Fri, 17 Jan 2025 11:04:47 -0500 Subject: [PATCH 1/3] update install instructions --- .github/workflows/e2e-android-self.yml | 2 +- .github/workflows/e2e-android.yml | 2 +- .github/workflows/e2e-ios-self.yml | 2 +- .github/workflows/e2e-ios.yml | 2 +- packages/desktop/README.md | 2 +- packages/e2e-tests/README.md | 6 +++--- packages/mobile/README.md | 2 +- 7 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/workflows/e2e-android-self.yml b/.github/workflows/e2e-android-self.yml index 17c632a72d..1c49fb5338 100644 --- a/.github/workflows/e2e-android-self.yml +++ b/.github/workflows/e2e-android-self.yml @@ -21,7 +21,7 @@ jobs: - name: Install dependencies run: | npm i - npm run lerna bootstrap --scope @quiet/eslint-config,@quiet/logger,@quiet/common,@quiet/types,@quiet/state-manager,@quiet/backend,@quiet/identity,@quiet/mobile,backend-bundle + npm run bootstrap --scope @quiet/eslint-config,@quiet/logger,@quiet/common,@quiet/types,@quiet/state-manager,@quiet/backend,@quiet/identity,@quiet/mobile,backend-bundle - name: Pull binaries run: | diff --git a/.github/workflows/e2e-android.yml b/.github/workflows/e2e-android.yml index 6d623bc1e0..7279140075 100644 --- a/.github/workflows/e2e-android.yml +++ b/.github/workflows/e2e-android.yml @@ -20,7 +20,7 @@ jobs: - name: Install dependencies run: | npm ci - npm run lerna bootstrap -- --scope=\'{@quiet/eslint-config,@quiet/logger,@quiet/common,@quiet/types,@quiet/state-manager,@quiet/backend,@quiet/identity,@quiet/mobile,backend-bundle}\' + npm run bootstrap -- --scope=\'{@quiet/eslint-config,@quiet/logger,@quiet/common,@quiet/types,@quiet/state-manager,@quiet/backend,@quiet/identity,@quiet/mobile,backend-bundle}\' - name: Pull binaries run: | diff --git a/.github/workflows/e2e-ios-self.yml b/.github/workflows/e2e-ios-self.yml index b30dd185cb..502b328677 100644 --- a/.github/workflows/e2e-ios-self.yml +++ b/.github/workflows/e2e-ios-self.yml @@ -22,7 +22,7 @@ jobs: - name: Install dependencies run: | npm i - npm run lerna bootstrap --scope @quiet/eslint-config,@quiet/logger,@quiet/common,@quiet/types,@quiet/state-manager,@quiet/backend,@quiet/identity,@quiet/mobile,backend-bundle + npm run bootstrap --scope @quiet/eslint-config,@quiet/logger,@quiet/common,@quiet/types,@quiet/state-manager,@quiet/backend,@quiet/identity,@quiet/mobile,backend-bundle - name: Install pods run: | diff --git a/.github/workflows/e2e-ios.yml b/.github/workflows/e2e-ios.yml index 33180207ef..60c2005b96 100644 --- a/.github/workflows/e2e-ios.yml +++ b/.github/workflows/e2e-ios.yml @@ -20,7 +20,7 @@ jobs: - name: Install dependencies run: | npm ci - npm run lerna bootstrap -- --scope=\'{@quiet/eslint-config,@quiet/logger,@quiet/common,@quiet/types,@quiet/state-manager,@quiet/backend,@quiet/identity,@quiet/mobile,backend-bundle}\' + npm run bootstrap -- --scope=\'{@quiet/eslint-config,@quiet/logger,@quiet/common,@quiet/types,@quiet/state-manager,@quiet/backend,@quiet/identity,@quiet/mobile,backend-bundle}\' - name: Pull binaries run: | diff --git a/packages/desktop/README.md b/packages/desktop/README.md index 1e7afa36a3..929cd5cc0e 100644 --- a/packages/desktop/README.md +++ b/packages/desktop/README.md @@ -10,7 +10,7 @@ Here are the steps: ``` npm i lerna@6.6.2 npm i typescript@4.9.3 -npm run lerna bootstrap +npm run bootstrap ``` If you run into problems please double check if you have exact version Node and NPM as listed in point 0. diff --git a/packages/e2e-tests/README.md b/packages/e2e-tests/README.md index f8223deb00..ee6962b03b 100644 --- a/packages/e2e-tests/README.md +++ b/packages/e2e-tests/README.md @@ -3,7 +3,7 @@ * Install chromedriver correctly before running the tests: `export ELECTRON_CUSTOM_VERSION=23.0.0` -`npm run lerna bootstrap` +`npm run bootstrap` * Run jest: @@ -18,7 +18,7 @@ To run against binaries built locally (which will be in the `/dist` folder) you npm run test:localBinary ``` -This passes the `IS_LOCAL` flag and will use local binaries in the `/dist` directory (if the OS has been configured for it in the tests). Check the README in the `desktop` package for information on building binaries for each OS. +This passes the `IS_LOCAL` flag and will use local binaries in the `/dist` directory (if the OS has been configured for it in the tests). Check the README in the `desktop` package for information on building binaries for each OS. *You must compile the binary prior to running this command or it will fail!* @@ -33,4 +33,4 @@ The rest of the tests to be rewritten have been left on this commit fa1256e4d19f -lazyLoading -newUser.returns -In the current approach, installers are taken from github releases, but in the future the application will be built on CI \ No newline at end of file +In the current approach, installers are taken from github releases, but in the future the application will be built on CI diff --git a/packages/mobile/README.md b/packages/mobile/README.md index c4a9bcd16c..cd9b81b845 100644 --- a/packages/mobile/README.md +++ b/packages/mobile/README.md @@ -12,7 +12,7 @@ Quiet Mobile is a React Native app for Android and iOS that shares a Node.js [ba ```bash npm install - npm run lerna bootstrap + npm run bootstrap ``` 1. On your host, install [adb](https://developer.android.com/studio/command-line/adb) (Android Debug Bridge) to communicate with your Android device. From b200af7e1f4a68d689c563b0a53127257429bb4a Mon Sep 17 00:00:00 2001 From: taea Date: Fri, 17 Jan 2025 18:03:50 -0500 Subject: [PATCH 2/3] add python install --- packages/desktop/README.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/packages/desktop/README.md b/packages/desktop/README.md index 929cd5cc0e..e3d7cf2da2 100644 --- a/packages/desktop/README.md +++ b/packages/desktop/README.md @@ -3,23 +3,40 @@ Running the desktop version of Quiet should be straightforward on Mac and Linux. On Windows we recommend using git-bash or just wsl. Here are the steps: -0. Install `patch` (e.g. via your Linux package manager) -1. Use `Node 18.12.1` and `npm 8.19.2`. We recommend [nvm](https://github.com/nvm-sh/nvm) for easily switching Node versions, and if this README gets out of date you can see the actual version used by CI [here](https://github.com/TryQuiet/quiet/blob/master/.github/actions/setup-env/action.yml). If you are using nvm, you can run `nvm use` in the project's root to switch to the correct version. -2. In `quiet/` (project's root) install monorepo's dependencies and bootstrap the project with lerna. It will take care of the package's dependencies and trigger a prepublish script which builds them. +1. Install `patch` (e.g. via your Linux package manager) + +2. Use `Node 18.12.1` and `npm 8.19.2`. We recommend [nvm](https://github.com/nvm-sh/nvm) for easily switching Node versions, and if this README gets out of date you can see the actual version used by CI [here](https://github.com/TryQuiet/quiet/blob/master/.github/actions/setup-env/action.yml). If you are using nvm, you can run `nvm use` in the project's root to switch to the correct version. + +3. Initialize submodules in the project's root: + +``` +git submodule update --init --recursive +``` + +4. Install python setuptools + +``` +python3 -m pip install setuptools +``` + +5. In `quiet/` (project's root) install monorepo's dependencies and bootstrap the project with lerna. It will take care of the package's dependencies and trigger a prepublish script which builds them. ``` npm i lerna@6.6.2 npm i typescript@4.9.3 +npm i -g pnpm@9.12.1 // may be needed depending on configuration +npm install npm run bootstrap ``` -If you run into problems please double check if you have exact version Node and NPM as listed in point 0. +If you run into problems please double check if you have exact version Node and NPM as listed in point 1. -3. In `quiet/packages/desktop` run: +6. In project root run, ``` -npm run start +npm run start:desktop ``` + ---- ## Versioning packages From 0900be06a1c41559864fe957c942e8f7bc2f0306 Mon Sep 17 00:00:00 2001 From: taea Date: Mon, 20 Jan 2025 10:47:29 -0500 Subject: [PATCH 3/3] add python install step to mobile readme --- packages/desktop/README.md | 6 +----- packages/mobile/README.md | 2 ++ 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/packages/desktop/README.md b/packages/desktop/README.md index e3d7cf2da2..1783a2905e 100644 --- a/packages/desktop/README.md +++ b/packages/desktop/README.md @@ -13,11 +13,7 @@ Here are the steps: git submodule update --init --recursive ``` -4. Install python setuptools - -``` -python3 -m pip install setuptools -``` +4. Install python3 and setuptools through your preferred method. (used by node-gyp) 5. In `quiet/` (project's root) install monorepo's dependencies and bootstrap the project with lerna. It will take care of the package's dependencies and trigger a prepublish script which builds them. diff --git a/packages/mobile/README.md b/packages/mobile/README.md index cd9b81b845..a489cc3904 100644 --- a/packages/mobile/README.md +++ b/packages/mobile/README.md @@ -8,6 +8,8 @@ Quiet Mobile is a React Native app for Android and iOS that shares a Node.js [ba 1. If not on Mac (which comes preinstalled with `patch`), install `patch` (e.g. via your Linux package manager). +1. Install python3 and setuptools through your preferred method. (used by node-gyp) + 1. In the root directory of `quiet/`, install the monorepo's dependencies and bootstrap the project with lerna. It will take care of the package's dependencies and trigger a prepublish script which builds them. ```bash