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

[docs] update quick-start

parent 367f245c
Branches
Tags
No related merge requests found
# Quick-start-guide : start a duniter node with web-ui from source # Quick-start-guide : start a duniter node with web-ui from source
## Prerequisite : ## Prerequisite
- git ([Windows, Mac, Linux](https://git-scm.com/downloads))
- nodejs ([Windows, Mac](https://nodejs.org/), [Linux](https://nodejs.org/en/download/package-manager/))
- python 2.7 ([Windows, Mac](https://www.python.org/downloads/), Linux -> you allready have it)
- gcc ([Windows, Mac, Linux](https://github.com/nodejs/node-gyp#installation))
- [GitHub](https://github.com/) account (optional, needed to contribute)
Alternative : for Windows user who love screenshot : [from Windows Installation to ready to use nodejs](https://www.serverpals.com/blog/building-using-node-gyp-with-visual-studio-express-2015-on-windows-10-pro-x64#user-content-fresh-windows-installation) - [git](https://git-scm.com/downloads)
- [nvm](https://github.com/nvm-sh/nvm#installing-and-updating)
[//]: # ([prepare your computer to use nodejs (Windows, Mac, Linux)]() http://osxdaily.com/2014/02/12/install-command-line-tools-mac-os-x/ https://github.com/creationix/nvm#install-script ) - [yarn](https://classic.yarnpkg.com/en/docs/install/)
- [python 2.7](https://www.python.org/downloads/) (Linux? -> you allready have it)
- [gcc](https://github.com/nodejs/node-gyp#installation)
- [rust](https://www.rust-lang.org/learn/get-started)
- [Gitlab](https://git.duniter.org/) account (optional, needed to contribute)
## Install ## Install
```bash ```bash
git clone https://github.com/duniter/duniter.git git clone https://git.duniter.org/nodes/typescript/duniter.git
cd duniter cd duniter
npm run full-install yarn
npm run webstart yarn add duniter-ui
bin/duniter webstart
``` ```
Connect to your duniter-node admin web-panel on : [http://localhost:9220/](http://localhost:9220/) Connect to your duniter-node admin web-panel on : [http://localhost:9220/](http://localhost:9220/)
## Contribute ## Contribute
- On github, fork https://github.com/duniter/duniter on your account repository. - On gitlab, fork https://git.duniter.org/nodes/typescript/duniter on your account repository.
- Change, improve, do what will be usefull. - Change, improve, do what will be usefull.
- Run `npm test` and if it's ok - Run `yarn test` and if it's ok
- Run `git remote add myFork https://github.com/<<yourAccount>>/duniter.git` or similar writable git repository. - Run `git remote add myFork https://git.duniter.org/<<yourAccount>>/duniter.git` or similar writable git repository.
- Run `git add .` or other command to prepare your commit - Run `git add .` or other command to prepare your commit
- Run `git status` to check what will be in your commit - Run `git status` to check what will be in your commit
- Run `git commit -m "explain what you have do/improve"` - Run `git commit -m "explain what you have do/improve"`
- Run `git push myFork` - Run `git push myFork`
- On github create a pull-request for your contrib. - On gitlab create a merge-request for your contrib.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment