Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yash22222/cryptobank

Crypto Bank is a decentralized blockchain application that enables secure transactions between users. It allows users to create and manage transactions, mine blocks, and validate the blockchain. With a focus on transparency and security, Crypto Bank ensures the integrity of transaction records in a reliable digital currency platform.
https://github.com/yash22222/cryptobank

backend blockchain blockchain-technology cryptocurrencies cryptography crytobank decentralized-applications flask frontend mining validity

Last synced: 4 days ago
JSON representation

Host: GitHub
URL: https://github.com/yash22222/cryptobank
Owner: Yash22222
License: mit
Created: 2024-10-14T16:30:53.000Z (about 1 month ago)
Default Branch: main
Last Pushed: 2024-10-15T16:33:31.000Z (30 days ago)
Last Synced: 2024-10-16T22:32:06.529Z (28 days ago)
Topics: backend, blockchain, blockchain-technology, cryptocurrencies, cryptography, crytobank, decentralized-applications, flask, frontend, mining, validity
Language: Python
Homepage: https://yashashokshirsath.netlify.app/
Size: 9.32 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Crypto Bank

## Description
Crypto Bank is a decentralized blockchain application that enables secure transactions between users. It allows users to create and manage transactions, mine blocks, and validate the blockchain. With a focus on transparency and security, Crypto Bank ensures the integrity of transaction records in a reliable digital currency platform.

## Features
- Create and manage transactions
- Mine new blocks
- Validate the blockchain
- View transaction history

## Prerequisites
- Python 3.x
- Flask
- Flask-CORS (for cross-origin requests)
- React (for frontend)

## Installation

### Clone the Repository
Clone this repository to your local machine using:
```bash
git clone https://github.com/Yash22222/CryptoBank.git
```

### Navigate to the Project Directory
```bash
cd CryptoBank
```

### Set Up the Backend
1. Navigate to the backend directory:
```bash
cd backend
```

2. Create a virtual environment (optional but recommended):
```bash
python -m venv venv
```

3. Activate the virtual environment:
- On Windows:
```bash
venv\Scripts\activate
```
- On macOS/Linux:
```bash
source venv/bin/activate
```

4. Install the required dependencies:
```bash
pip install -r requirements.txt
```

### Set Up the Frontend
1. Navigate to the frontend directory:
```bash
cd ../frontend
```

2. Install the frontend dependencies:
```bash
npm install
```

## Running the Application

### Start the Backend Server
1. Navigate back to the backend directory:
```bash
cd ../backend
```

2. Run the Flask application:
```bash
python app.py
```
The backend server should start running at `http://127.0.0.1:5000/`.

### Start the Frontend Server
1. Open a new terminal window and navigate to the frontend directory:
```bash
cd CryptoBank/frontend
```

2. Start the React application:
```bash
npm start
```
The frontend will be accessible at `http://localhost:3000/`.

## Usage

### API Endpoints
- **GET /**: Welcome message.
- **GET /mine**: Mine a new block.
- **POST /transaction**: Create a new transaction (provide JSON body).
- **GET /chain**: View the entire blockchain.
- **GET /validate**: Validate the blockchain.

### Example Requests
#### Create a Transaction
Use Postman or any REST client to send a POST request to:
```
http://127.0.0.1:5000/transaction
```
With the following JSON body:
```json
{
"sender": "Alice",
"recipient": "Bob",
"amount": 10
}
```

#### Mine a Block
Send a GET request to:
```
http://127.0.0.1:5000/mine
```
You will receive a JSON response indicating that a new block has been mined.

#### Validate the Blockchain
Send a GET request to:
```
http://127.0.0.1:5000/validate
```
This will return a response indicating whether the blockchain is valid or not.

#### View the Blockchain
Send a GET request to:
```
http://127.0.0.1:5000/chain
```
This will return the complete blockchain, showing all blocks and transactions.

### Output
After successfully creating a transaction or mining a block, you will receive a JSON response indicating the success of the operation. For example, after mining a block, you might see:
```json
{
"message": "New block mined successfully!",
"block": {
"index": 1,
"transactions": [...],
"proof": 12345,
"previous_hash": "abcdef..."
}
}
```

## Why This Project is Useful
Crypto Bank demonstrates the practical implementation of blockchain technology, showcasing how transactions can be securely processed in a decentralized manner. It provides insights into the workings of cryptocurrencies and the fundamental concepts of blockchain.

## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
```