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.

Sign up for GitHub

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

Jump to bottom

Fix installation instructions #1012

Merged
merged 2 commits into from
Oct 25, 2021
Merged

Fix installation instructions #1012

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f0a1336
Fix installation instructions
davidbrochart Oct 25, 2021
fa3da6c
Use yarn install
davidbrochart Oct 25, 2021
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
5 changes: 2 additions & 3 deletions docs/source/contribute.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,15 @@ First, you need to fork the project. Then setup your environment:
.. code-block:: bash

# create a new conda environment
conda create -n voila -c conda-forge notebook nodejs
conda create -n voila -c conda-forge notebook jupyterlab nodejs yarn pip
conda activate voila

# download voila from your GitHub fork
git clone https://github.com/<your-github-username>/voila.git

# install JS dependencies and build js assets
cd voila/js
cd voila
npm install
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should it be yarn install?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know, npm install worked for me 😄

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But I see we have yarn.lock files around so it seems we actually use yarn and not npm?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No idea.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well we shouldn't mix yarn and npm, so we need to make a choice. I guess if we have yarn around we should stop using npm. Or we remove the yarn.lock and commit the package-lock.json npm generates.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I personally prefer npm over yarn but since we had the yarn.lock already, we should stick with yarn

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 on sticking with yarn from my side. It seems to be faster and the lock file is smaller.

npm install -g yarn

yarn can be installed from conda-forge.

cd ..

# install Voilà in editable mode
python -m pip install -e .
Expand Down