-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
44 additions
and
79 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 |
---|---|---|
@@ -1 +1 @@ | ||
v16 | ||
v20 |
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 |
---|---|---|
|
@@ -44,49 +44,38 @@ flowchart LR | |
|
||
The following instructions will install the required dependencies, build Disco.js and launch a DISCO server and a web client. If you run into any sort of trouble check our [FAQ](./docs/FAQ.md); otherwise please create a new issue or feel free to ask on [our slack](https://join.slack.com/t/disco-decentralized/shared_invite/zt-fpsb7c9h-1M9hnbaSonZ7lAgJRTyNsw). | ||
|
||
**1.** We recommend using [nvm](https://github.com/nvm-sh/nvm) (Node Version Manager) to handle multiple Node.js versions. Start by installing `nvm` by following [their installation instructions](https://github.com/nvm-sh/nvm). | ||
After installation, you should be able to run | ||
**1.** Clone the repository | ||
|
||
``` | ||
nvm -v | ||
0.39.7 # my nvm version at the time | ||
git clone [email protected]:epfml/disco.git | ||
cd disco | ||
``` | ||
|
||
**2.** Install Node.js version 16 | ||
**2.** Install Node.js | ||
|
||
``` | ||
nvm install 16 | ||
``` | ||
|
||
You can now choose which Node.js version to use: | ||
We recommend using [nvm](https://github.com/nvm-sh/nvm) (Node Version Manager) to handle multiple Node.js versions. Start by installing `nvm` by following [their installation instructions](https://github.com/nvm-sh/nvm). | ||
After installation, you should be able to run | ||
|
||
``` | ||
nvm use 16 | ||
nvm -v | ||
0.39.7 # at the time of writing | ||
``` | ||
|
||
Using Node.js v16 should automatically set your [npm](https://docs.npmjs.com/about-npm) (Node Package Manager, different from n**v**m) version to 8: | ||
Use it to install the version we use in DISCO. | ||
|
||
``` | ||
npm --version | ||
8.xx.xx | ||
nvm install # it reads `.nvmrc` to select the correct version | ||
``` | ||
|
||
`nvm` manages your different Node.js versions while `npm` handles your different Node.js project packages within one version. | ||
|
||
**3.** Clone the repository | ||
|
||
``` | ||
git clone [email protected]:epfml/disco.git | ||
cd disco | ||
``` | ||
|
||
**4.** Install the dependencies | ||
**3.** Install the dependencies | ||
|
||
``` | ||
npm ci | ||
``` | ||
|
||
**5.** Build the projects | ||
**4.** Build the projects | ||
|
||
Then we need to builds the packages meaning compile TypeScript into JavaScript. | ||
|
||
|
@@ -98,13 +87,13 @@ Or you can select a specific workspace via `--workspace=$name-or-path-to-package | |
npm -ws run build | ||
``` | ||
|
||
**6.** Download and extract the sample training datasets. These datasets are used in the automated tests. | ||
**5.** Download and extract the sample training datasets. These datasets are used in the automated tests. | ||
|
||
``` | ||
./datasets/populate | ||
``` | ||
|
||
**7.** Launch DISCO | ||
**6.** Launch DISCO | ||
|
||
As you may have seen, there are many ways to use DISCO. Here we will run a server and a web client. From there, a user can use DISCO from their browser. | ||
|
||
|
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