-
Notifications
You must be signed in to change notification settings - Fork 90
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* update install instructions * add python install * add python install step to mobile readme
- Loading branch information
Showing
7 changed files
with
30 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters