https://github.com/nuls-io/nuls-v1
https://github.com/nuls-io/nuls-v1
blockchain cryptocurrency modular proof-of-credit
Last synced: 29 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/nuls-io/nuls-v1
- Owner: nuls-io
- License: mit
- Created: 2017-09-28T02:42:23.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-06T00:41:37.000Z (over 2 years ago)
- Last Synced: 2024-04-24T12:34:50.876Z (about 1 year ago)
- Topics: blockchain, cryptocurrency, modular, proof-of-credit
- Language: Java
- Size: 71.6 MB
- Stars: 359
- Watchers: 88
- Forks: 91
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nuls
**Welcome to Nuls!**
## Introduction
Nuls is a global blockchain open-source project which is a highly customizable modular blockchain infrastructure.
It consists of a microkernel and functional modules.
Nuls provides smart contract, multi-chain mechanism and cross-chain consensus.
It aims to break the technical barriers of blockchain, to reduce the cost of development, and to promote the usage of blockchain technology in the commercial field.
**Project Features**
- Modular design
- Parallel chains
- Smart contract
- POC consensus mechanisms
To learn more about us, visit [nuls.io](https://nuls.io/).
## Contributing to Nuls
Contributions to Nuls are welcomed!
We sincerely invite developers who experienced in blockchain field to join in NULS technology community.
Details: s: https://nuls.communimunity/d/9-recruitment-of-community-developers
To be a great community, Nuls needs to welcome developers from all walks of life, with different backgrounds, and with a wide range of experience.
## Getting Started
### Requirements
**Operating System**
Nuls is based on the Java and you can choose your favorite OS.
**Dependencies SDK**
JDK:[JDK 1.8](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
Maven:[Maven 3.3+](http://maven.apache.org/download.cgi)
IDE: Any one you like
> JetBrains [IntelliJ IDEA](https://www.jetbrains.com/idea/) is recommended, but we do not rovoke the IDE war.
### Code style guide
Use Alibaba Java Coding Guidelines [@Github](https://github.com/alibaba/p3c).
* [Alibaba-Java-Coding-Guidelines](https://alibaba.github.io/Alibaba-Java-Coding-Guidelines/)
> recommend use IDE plugin lint code. [wiki](https://github.com/alibaba/p3c/wiki)
> * [IntelliJ IDEA Plugin](https://github.com/alibaba/p3c/tree/master/idea-plugin)
> * [Eclipse Plugin](https://github.com/alibaba/p3c/tree/master/eclipse-plugin)
### Branch Description
mainnet: main network wallet code
testnet : test network wallet code
master : main branch, the latest version available,Can be used for technical research.
develop : branch in development
Others : other branches are designed according to gitflow
### Getting Sources
```shell
git clone https://github.com/nuls-io/nuls.git && cd nuls
```
### Building Sources
Make sure installed JDK 1.8 & maven 3.3+
```shell
$ mvn -v
Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-18T02:33:14+08:00)
Maven home: /usr/local/Cellar/maven/3.5.4/libexec
Java version: 1.8.0_171, vendor: Oracle Corporation, runtime: /Library/Java/JavaVirtualMachines/jdk1.8.0_171.jdk/Contents/Home/jre
```
Build
```shell
$ mvn clean package
```
> You may be need add command line argument "-Dmaven.test.skip=true" at this stage.
### Running
```shell
$ mvn clean package
$ cd client-module/client/target
$ mkdir nuls-node
$ tar -zxvf nuls-node.tar.gz -C nuls-node
$ cd nuls-node/bin
```
Using start.sh running the nuls process.
Using stop.sh stop the nuls process.
> Using IDE run or debug need execute command "mvn install" first.
### Process EntryPoint
> nuls/client-module/client/src/main/java/io/nuls/client/Bootstrap.java
## License
Nuls is released under the [MIT](http://opensource.org/licenses/MIT) license.
Modules added in the future may be release under different license, will specified in the module library path.
## Community
* [Nuls.io](https://nuls.io/)
* [@twitter](https://twitter.com/nulsservice)
* [facebook](https://www.facebook.com/nulscommunity/)
* [YouTube channel ](https://www.youtube.com/channel/UC8FkLeF4QW6Undm4B3InN1Q?view_as=subscriber)
* Telegram [Nuls Community](https://t.me/Nulsio)
* Telegram [Nuls 中文社区](https://t.me/Nulscn)