README.md 3.79 KB
Newer Older
1
![Duniter logo](https://git.duniter.org/nodes/typescript/duniter/raw/dev/images/250%C3%97250.png)
Moul's avatar
Moul committed
2

3
# Duniter [![Build Status](https://api.travis-ci.org/duniter/duniter.png)](https://travis-ci.org/duniter/duniter) [![Coverage Status](https://coveralls.io/repos/github/duniter/duniter/badge.svg?branch=master)](https://coveralls.io/github/duniter/duniter?branch=master) [![Dependencies](https://david-dm.org/duniter/duniter.svg)](https://david-dm.org/duniter/duniter)
Cédric Moreau's avatar
Cédric Moreau committed
4

5
Duniter (previously uCoin) is a libre software allowing to create a new kind of P2P crypto-currencies based on individuals and Universal Dividend.
6

7
Inspired by [Bitcoin](https://github.com/bitcoin/bitcoin) and [OpenUDC](https://github.com/Open-UDC/open-udc) projects.
Cédric Moreau's avatar
Cédric Moreau committed
8

9
<p align="center"><img src="https://git.duniter.org/nodes/typescript/duniter/raw/dev/images/duniter_admin_g1.png" /></p>
10

Cédric Moreau's avatar
Cédric Moreau committed
11
## Development state
12

13
[Ğ1, first libre currency for production using Duniter have been launched March 8th 2017](https://en.duniter.org/g1-go/).
Cédric Moreau's avatar
Cédric Moreau committed
14

15
However, we are running simultaneously a testing currency.
Cédric Moreau's avatar
Cédric Moreau committed
16
17

### Add your node to the network
18

19
See [Install a node documentation](https://duniter.org/en/wiki/duniter/install/).
Cédric Moreau's avatar
Cédric Moreau committed
20

21
### Clients, wallets
22

23
#### Cesium
24

25
26
- [Website](https://cesium.app/)
- [Repository](https://git.duniter.org/clients/cesium-grp/cesium)
27

28
#### Sakia
29

30
- [Website](http://sakia-wallet.org)
31
- [Repository](https://git.duniter.org/clients/python/sakia)
Cédric Moreau's avatar
Cédric Moreau committed
32

33
#### Silkaj
34

35
- [Website](https://silkaj.duniter.org)
36
- [Repository](https://git.duniter.org/clients/python/silkaj)
Cédric Moreau's avatar
Cédric Moreau committed
37

Cédric Moreau's avatar
Cédric Moreau committed
38
## Going further
39

40
### Contribute
41

42
43
44
- [Quick-start-guide : start a duniter node with web-ui from source](https://git.duniter.org/nodes/typescript/duniter/blob/dev/doc/quick-start.md)
- [Guide (fr)](https://git.duniter.org/nodes/typescript/duniter/blob/dev/doc/contribute-french.md)
- [Developer guide](https://git.duniter.org/nodes/typescript/duniter/blob/dev/doc/developer-guide.md)
45

Cédric Moreau's avatar
Cédric Moreau committed
46
### Documentation
47

48
Visit [Duniter website](https://duniter.org): it gathers theoretical informations, FAQ and several useful links. If you want to learn, this is the first place to visit.
Cédric Moreau's avatar
Cédric Moreau committed
49

50
### Talk about/get involved in Duniter project
51

52
If you wish to participate/debate on Duniter, you can:
Cédric Moreau's avatar
Cédric Moreau committed
53

54
55
56
57
- visit [Duniter Forum](https://forum.duniter.org)
- join [XMPP chatroom](https://chat.duniter.org) [xmpp://duniter@muc.duniter.org](xmpp://duniter@muc.duniter.org)
- contact us directly at [contact@duniter.org](mailto:contact@duniter.org)
- subscribe to [a mailing list for Duniter node's administrators](https://listes.aquilenet.fr/sympa/subscribe/duniter-node-admins)
58

Moul's avatar
Moul committed
59
### Developement
60

Moul's avatar
Moul committed
61
Duniter is using modules on different git repositories:
62
63

- [WotB](https://git.duniter.org/libs/dubp-wot): compute Web of Trust.
Moul's avatar
Moul committed
64
- [Debug](https://github.com/duniter/duniter-debug): debug tool.
65
66
- [Web admin](https://git.duniter.org/nodes/typescript/modules/duniter-ui): web administration interface (optional).
- [GVA](https://git.duniter.org/nodes/typescript/modules/gva-api): Future client API aimed to replace BMA. GVA stands for GraphQL Validation API.
Moul's avatar
Moul committed
67
68

Optional modules:
69

70
- [Currency monit](https://git.duniter.org/nodes/typescript/modules/duniter-currency-monit): charts to monitor currency and web of trust state.
Moul's avatar
Moul committed
71
72
73
- [Remuniter](https://github.com/duniter/remuniter): service to remunerate blocks issuers.
- [Wot explorer](https://github.com/c-geek/wotex): Web of Trust explorer.

Cédric Moreau's avatar
Cédric Moreau committed
74
# References
75

76
## Theoretical
77
78
79

- [(en) Relative theory of money](http://en.trm.creationmonetaire.info)
- [(fr) Théorie relative de la monnaie](http://trm.creationmonetaire.info)
80
81

## OpenUDC
82
83
84

- [OpenUDC repository](https://github.com/Open-UDC/open-udc)
- [Other project trying to implement OpenUDC in python](https://github.com/canercandan/django-openudc)
Cédric Moreau's avatar
Cédric Moreau committed
85

Cédric Moreau's avatar
Cédric Moreau committed
86
# License
87

88
This software is distributed under [GNU AGPLv3](https://git.duniter.org/nodes/typescript/duniter/blob/dev/LICENSE).