blockshell/README.md

65 lines
2.3 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<img src="https://img.shields.io/david/dev/expressjs/express.svg"> [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=https%3A%2F%2Ftwitter.com%2Fintent%2Ftweet%3Ftext%3DLearn%20blockchain%2020%20minutes%20-%20https%3A%2F%2Fgithub.com%2Fdaxeel%2Fblockshell)
📖 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
:------------------------------:|:-------------------------:
![](https://preview.ibb.co/iZa5jG/Screen_Shot_2018_01_25_at_11_25_22_PM.png) | ![](https://preview.ibb.co/cDB0Jb/Screen_Shot_2018_01_25_at_11_25_35_PM.png)
## 📦 Installation
Step 1 - Create project directory
```
mkdir <project_name> && cd project_name
```
Step 2 - Create new virtual environment
```
virtualenv venv
```
Step 3 - Activate virtual environment
```
source venv/bin/activate
```
Step 4 - Clone this repo
```
git clone https://github.com/daxeel/blockshell.git
```
Step 5 - Change directory to cloned one
```
cd blockshell
```
Step 6 - Install blockshell
```
pip install --editable .
```
Step 7 - 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">