README.md 4.32 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

Éloïs's avatar
Éloïs committed
3
# Duniter [![build status](https://git.duniter.org/nodes/typescript/duniter/badges/dev/pipeline.svg)](https://git.duniter.org/nodes/typescript/duniter/commits/dev) [![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) [![Minimum rustc version](https://img.shields.io/badge/rustc-1.47.0+-yellow.svg)](https://github.com/rust-lang/rust/blob/master/RELEASES.md)
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
- See [CONTRIBUTING](./CONTRIBUTING.md).
- [Guide (fr)](./doc/dev/contribute-french.md)
44

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

47
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
48

Éloïs's avatar
Éloïs committed
49 50
For technical documentation, refer to the `doc` folder of this git repository.

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

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

55 56 57 58
- 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)
59

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

62 63 64
Duniter is currently migrating from [Typescript] to [Rust].
This migration is being done gradually via a [NodeJs]<->[Rust] binding provided by [Neon].
The fact of migrating from code to [Rust] is commonly called "oxidation", so we speak of "Duniter's oxidation".
65

66 67 68 69 70 71
The long-term goal is to oxidize Duniter entirely, but it is a long process that will take several years.

Duniter is divided into several  git repositories:

- [Duniter](https://git.duniter.org/nodes/typescript/duniter): this repository.
- [Dubp-rs-libs](https://git.duniter.org/libs/dubp-rs-libs): Set of Rust libraries common to Duniter and a possible future Rust client/wallet.
72 73
- [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
74

75
Optional repositories:
76

77
- [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
78 79
- [Remuniter](https://github.com/duniter/remuniter): service to remunerate blocks issuers.

Cédric Moreau's avatar
Cédric Moreau committed
80
# References
81

82
## Theoretical
83 84 85

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

## OpenUDC
88 89 90

- [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
91

Cédric Moreau's avatar
Cédric Moreau committed
92
# License
93

94
This software is distributed under [GNU AGPLv3](https://git.duniter.org/nodes/typescript/duniter/blob/dev/LICENSE).
95 96 97 98 99

[Neon]: https://neon-bindings.com/
[NodeJs]: https://nodejs.org/en/
[Rust]: https://www.rust-lang.org/
[Typescript]: https://www.typescriptlang.org/