COCOL!
🌐
About The Cocol Project has the goal to lower the entry barrier for developers interested in building blockchains and dApps. There is still a long way to go and your help is needed.
🏹
Installation Cocol is written in Crystal, so make sure to follow the installation instructions first.
After setting up Crystal you can clone the Cocol repository and install the dependencies:
> git clone https://github.com/cocol-project/cocol.git
> cd cocol
> shards install
⚔
Usage Make your changes to the code-base and than build Cocol
> make
The binary ./cocol
offers the following CLI options
Options:
-p --port The port your Cocol node is going to run on
-m --master Making this node a master (there can only be one)
--max-connections Setting the max-connections for peers.
--miner Making this node a miner
--update Triggering an update on launch (will catch up with the current height)
There is also a script that starts multiple nodes and the master for you
> ./script/start.sh 66 5
First option is the amount of nodes and the second amount of miner.
It will start the master node with the port 3000
and every other node with
3000 + n
, while all miner have port 4000 + n
Now go ahead and open the explorer in a browser:
> open ./explorer/index.html
You should see 66 nodes and a miner (red border)
Each one of the nodes has a REST API on the corresponding port (e.g. 3001
)
Start creating live fake transactions and watch the network come alive
> crystal script/live.cr
👩💻 👨💻
Development Cocol is in a very early stage. Expect changes, bugs and messy code. Test coverage sucks atm.
👷♀️ 👷♂
Contributing ️- Fork it ( https://github.com/cocol-project/cocol/fork )
- Create your feature branch (git checkout -b my-new-feature)
- Commit your changes (git commit -am 'Add some feature')
- Push to the branch (git push origin my-new-feature)
- Create a new Pull Request
Contributors
- github: cserb | twitter: @cerbivore | Cristian Șerb - creator, maintainer