58 lines
1.9 KiB
Markdown
58 lines
1.9 KiB
Markdown
📖 README.md just includes installation guide. You can find detailed guide in this <a href="https://github.com/daxeel/blockshell/wiki/Get-Started-with-BlockShell" target="_blank">wiki page</a>
|
||
|
||
# BlockShell
|
||
A command line utility for learning Blockchain technical concepts likechaining, mining, proof of work etc.
|
||
|
||
<img src="https://image.ibb.co/mJFNGw/blockshell.gif">
|
||
<img src="https://preview.ibb.co/dhC7yb/Logomakr_5g_Ei_Dw.png" height="80">
|
||
|
||
## ℹ️ About
|
||
Anyone who wants to understand how blockchain technology works, then <b>BlockShell</b> should be a great start. Because I have created BlockShell keeping blockchain fundamentals in the center of development. With BlockShell you will actually create a tiny blockchain in your system where you can create blocks with data, explore blocks etc.
|
||
|
||
So, by using BlockShell anyone can learn following blockchain concepts,
|
||
* Block & Chaining
|
||
* Hashing
|
||
* Mining
|
||
* Proof of Work
|
||
|
||
## 🌐 BlockShell Web Explorer
|
||
<p>BlockShell comes with built-in blockchain explorer by which you can actully see how blocks are mined and what is stored and where.</p>
|
||
|
||
Latest Mined Blocks | Block Details
|
||
:------------------------------:|:-------------------------:
|
||
 | 
|
||
|
||
## 📦 Installation
|
||
Step 1 - Clone this repo
|
||
```
|
||
git clone https://github.com/daxeel/blockshell.git
|
||
```
|
||
|
||
Step 2 - Change directory to cloned one
|
||
```
|
||
cd blockshell
|
||
```
|
||
|
||
Step 3 - Create virtualenv
|
||
```
|
||
python3 -m venv .venv
|
||
```
|
||
|
||
Step 4 - Enable virtualenv
|
||
```
|
||
source .venv/bin/activate
|
||
```
|
||
|
||
Step 5 - Install blockshell
|
||
```
|
||
pip install --editable .
|
||
```
|
||
|
||
Step 6 - Try "blockshell" command and test installation!
|
||
```
|
||
blockshell
|
||
```
|
||
|
||
<b>Output in terminal after calling BlockShell command</b>
|
||
<img src="https://image.ibb.co/dRqGrw/Screen_Shot_2018_01_25_at_11_21_38_PM.png">
|