Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update install instructions #2703

Merged
merged 3 commits into from
Jan 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/e2e-android-self.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/e2e-android.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/e2e-ios-self.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/e2e-ios.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down
27 changes: 20 additions & 7 deletions packages/desktop/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,36 @@
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 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.

```
npm i [email protected]
npm i [email protected]
npm run lerna bootstrap
npm i -g [email protected] // 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
Expand Down
6 changes: 3 additions & 3 deletions packages/e2e-tests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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!*

Expand All @@ -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
In the current approach, installers are taken from github releases, but in the future the application will be built on CI
4 changes: 3 additions & 1 deletion packages/mobile/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@ 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
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.
Expand Down
Loading