Changeset View
Changeset View
Standalone View
Standalone View
docs/developer-setup.rst
Show All 31 Lines | package manager. On Debian/Ubuntu-based distributions:: | ||||
sudo apt update | sudo apt update | ||||
sudo apt install \ | sudo apt install \ | ||||
build-essential pkg-config lzip rsync \ | build-essential pkg-config lzip rsync \ | ||||
python3 python3-pip python3-venv virtualenvwrapper \ | python3 python3-pip python3-venv virtualenvwrapper \ | ||||
libpython3-dev libsystemd-dev libsvn-dev libffi-dev librdkafka-dev \ | libpython3-dev libsystemd-dev libsvn-dev libffi-dev librdkafka-dev \ | ||||
fuse3 libfuse3-dev libcmph-dev libleveldb-dev \ | fuse3 libfuse3-dev libcmph-dev libleveldb-dev \ | ||||
git myrepos \ | git myrepos \ | ||||
postgresql-autodoc graphviz plantuml inkscape \ | postgresql-autodoc graphviz plantuml inkscape \ | ||||
postgresql libpq-dev cassandra yarnpkg | postgresql libpq-dev cassandra | ||||
.. Note:: Python 3.7 or newer is required | .. Note:: Python 3.7 or newer is required | ||||
This installs basic system utilities, Python library dependencies, development tools, | This installs basic system utilities, Python library dependencies, development tools, | ||||
documentation tools and our main database management systems. | documentation tools and our main database management systems. | ||||
Cassandra and PostgreSQL will be started by tests when they need it, so you | Cassandra and PostgreSQL will be started by tests when they need it, so you | ||||
don't need them started globally (this will save you some RAM):: | don't need them started globally (this will save you some RAM):: | ||||
sudo systemctl disable --now cassandra postgresql | sudo systemctl disable --now cassandra postgresql | ||||
If you intend to hack on the frontend part of |swh| Web Applications, you will also | If you intend to hack on the frontend part of |swh| Web Applications, you will also | ||||
need to have nodejs >= 14 in your development environment. If the version in your | need to have ``nodejs >= 14`` in your development environment. If the version in your | ||||
Debian-based distribution is lower, you can install node 14 using these commands:: | Debian-based distribution is lower, you can install node 14 using these commands:: | ||||
sudo wget https://deb.nodesource.com/gpgkey/nodesource.gpg.key -O /etc/apt/trusted.gpg.d/nodesource.asc | sudo wget https://deb.nodesource.com/gpgkey/nodesource.gpg.key -O /etc/apt/trusted.gpg.d/nodesource.asc | ||||
echo "deb https://deb.nodesource.com/node_14.x $(lsb_release -cs) main" | sudo tee -a /etc/apt/sources.list.d/nodesource.list | echo "deb https://deb.nodesource.com/node_14.x $(lsb_release -cs) main" | sudo tee -a /etc/apt/sources.list.d/nodesource.list | ||||
sudo apt update | sudo apt update | ||||
sudo apt install nodejs | sudo apt install nodejs | ||||
Also related to Web Applications development, |swh| uses the ``yarn`` package manager | |||||
to retrieve frontend dependencies and development tools. It is recommended to install its | |||||
latest classic version using these commands:: | |||||
sudo wget https://dl.yarnpkg.com/debian/pubkey.gpg -O /etc/apt/trusted.gpg.d/yarn.asc | |||||
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list | |||||
sudo apt update | |||||
sudo apt install yarn | |||||
If you intend to work on |swh| archive search features, Elasticsearch must also be | If you intend to work on |swh| archive search features, Elasticsearch must also be | ||||
present in your development environment. Proceed as follows to install it:: | present in your development environment. Proceed as follows to install it:: | ||||
sudo wget https://artifacts.elastic.co/GPG-KEY-elasticsearch -O /etc/apt/trusted.gpg.d/elasticsearch.asc | sudo wget https://artifacts.elastic.co/GPG-KEY-elasticsearch -O /etc/apt/trusted.gpg.d/elasticsearch.asc | ||||
echo "deb https://artifacts.elastic.co/packages/7.x/apt stable main" | sudo tee -a /etc/apt/sources.list.d/elasticsearch.list | echo "deb https://artifacts.elastic.co/packages/7.x/apt stable main" | sudo tee -a /etc/apt/sources.list.d/elasticsearch.list | ||||
sudo apt update | sudo apt update | ||||
sudo apt install elasticsearch | sudo apt install elasticsearch | ||||
▲ Show 20 Lines • Show All 204 Lines • Show Last 20 Lines |