Skip to content

Latest commit

 

History

History
131 lines (120 loc) · 6.57 KB

R-Cell_R-Cell.md

File metadata and controls

131 lines (120 loc) · 6.57 KB

R-Cell🪙

The project aims at building its own cryptocurrency from scratch using block chain technology. The project uses Python language along with Flask Frameworks to deploy it on a localhost server. This project therefore not only gets us to know about block chain, encryptions and keys but also brings us closer to the world of cryptocurrency whose value is increasing day by day in the modern era.

📃Table Of Contents

🙂Introduction

🤔About Project

The project uses Blockchain Technology by implementation through Python and Flask in the backend for a server. It further uses SQL database for storing the user data such as password, username, email, account balance etc. Through HTML/CSS and JavaScript the Blockchain is deployed on a website. The website is on a local-host which is provided a server through ngrok. This project enhances the knowledge of blockchain technology which has a very high potential in future.

⚙️Tech-Stack

Python Java Script css html css flask VS Code MySQL Block-Chain

📁File Structure

R-Cell(main)
├─ static                   
│  ├─ css                   
│  │  ├─ index.css          
│  │  ├─ layout.css         
│  │  ├─ login.css          
│  │  └─ register.css       
│  └─ images                
│     ├─ background.jpeg    
│     ├─ favicon.ico        
│     ├─ favicon2.png       
│     ├─ home.png           
│     └─ profile.png        
├─ templates                
│  ├─ handlers              
│  │  └─ 404.html           
│  ├─ includes              
│  │  ├─ _formhelpers.html  
│  │  └─ _messages.html     
│  ├─ buy.html              
│  ├─ dashboard.html        
│  ├─ index.html            
│  ├─ layout.html           
│  ├─ login.html            
│  ├─ register.html         
│  └─ transaction.html      
├─ app.py                   
├─ blockchain.py            
├─ forms.py                 
└─ sqlhelpers.py

⚒️♂️Getting Started

😁Pre-requisites

The project involes the installation of following libraries and environment:

  • Firstly obviously you should have Python3.
  • Some basic libraries and frameworks will come pre-installed but you'll require MORE!!
  • Flask: This the the framework that supports the website so installing this is a must else it'll throw ERRORS!!
  • Requests: This module is used only once :(, but none the less it is important.
  • An SQL connection with Flask: This library ensures a connection between the MySQL Database and the Flask framework.
  • wtforms: A python library used for getting inuput from a user in forms

Install all these requirements:

$ pip install -r requirements.txt
  • Ngrok: For setting up the server for the website, Ngrok is required. Ngrok creates tunnels across local-host servers to make them behave as decentralized. Download Ngrok from the link provided.
    1. After installation open your prompt and run the following
    unzip /path/to/ngrok.zip
    1. Then open Ngrok and connect it to your account by copying the command provided on the website.

💻Usage

Assuming you have git, follow the following process

  1. Clone the Git Repo:

    $ git clone https://github.com/AsRaNi1/R-Cell.git

  2. Go into the Repo directory

    $ cd ../R-Cell

  3. Run the app.py file in the directory

    $ python app.py

  4. A local-host server address will open image

  5. Copy the local-host address and then open Ngrok

  6. In Ngrok paste the local-host link as follows:

    ngrok http *Your local-host link here*

  7. Viola!! Your Blockchain is up and running, NOW MAKE YOUR FRIENDS REGISTER AND BUY AND SEND R-CELL CURRENCY.

🔮Future Scope

Here are a few things we are planning on adding in the future

  • Wallet
  • mempools

👨‍💻Contributors

  • Arnav Zutshi
  • Meloni Patel
  • Prathameya Walimbe
  • Vedangi Patil

🙏Mentors

A very special thanks to the mentors!!

  • Ravi maurya
  • Nikheel Indanoor
  • Shreyas Penkar