Skip to content
Snippets Groups Projects
Commit 92fbca33 authored by Éloïs's avatar Éloïs
Browse files

[docs] use: add manual compilation instructions

parent 3972cd80
No related branches found
No related tags found
No related merge requests found
# Compile Duniter manually from source code
Title: Compile Duniter manually
Order: 1
Date: 2020-05-05
Slug: manual_compilation
Authors: elois
## Prerequisites
To compile Duniter manually, there is currently the following requirement:
- A computer with GNU/Linux or Mac as operating system
- Build essential tools
- tar or unzip or git (to download and extract source code)
- Nvm
- Rust
- Yarn
### Get source code
#### From archive tar.gz or zip
Url to download source code of a specific Duniter version X.Y.Z:
- tar.gz: https://git.duniter.org/nodes/typescript/duniter/repository/vX.Y.Z/archive.tar.gz
- zip: https://git.duniter.org/nodes/typescript/duniter/repository/vX.Y.Z/archive.zip
*Replace X.Y.Z with the version of Duniter you want to install.*
Then extract the archive to the folder of your choice.
#### With git
Latest stable version:
git clone https://git.duniter.org/nodes/typescript/duniter -b stable --depth 1
Specific version:
git clone https://git.duniter.org/nodes/typescript/duniter -b X.Y.Z --depth 1
*Replace X.Y.Z with the version of Duniter you want to install.*
### Install Prerequisites
#### Build essential tools
Build essential tools:
Depend on your distribution:
##### Debian/Ubuntu
apt-get install build-essential
##### Fedora
yum groupinstall "Development Tools" "Development Libraries"
TODO: If you know how to install build essential tools for other gnu/linux distributions or for mac, you can complete this documentation and submit a merge request.
#### Nvm and Rust
Nvm:
wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash
Rust:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -- -y
#### Yarn
Yarn: [installation instructions][yarn]
## Build the project
Go to the root of the folder where you extracted the source code (or possibly cloned from git).
### Install and use the correct version of nodejs
Check the required node version in the `package.json` file on line 5.
If, for example, version 10 is expected, install and select it with the following command:
nvm install 10 && nvm use 10
### Compile
**WARNING**: the compilation of the project requires a lot of resources on your machine, and several long minutes, don't do anything else at the same time!
Command to compile :
NEON_BUILD_RELEASE=true yarn add duniter-ui
### Set autocompletion
To install or update Duniter's command auto-completion:
cp release/extra/completion/duniter_completion.bash /etc/bash_completion.d/
### Run on command line
bin/duniter start
### Run on gui
bin/duniter webstart
then open `localhost:9220` on your browser.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment