Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codebatine/gochain
A cryptocurrency blockchain app with transaction management, mining, wallet, user admin, database, tdd and more.
https://github.com/codebatine/gochain
blockchain blockchain-nodes javascript jwt mining mining-rewards model-view-controller mongodb nodejs react-vite redis-server scss secure-server separation-of-concerns tdd transaction-management validation vitest
Last synced: 24 days ago
JSON representation
A cryptocurrency blockchain app with transaction management, mining, wallet, user admin, database, tdd and more.
- Host: GitHub
- URL: https://github.com/codebatine/gochain
- Owner: codebatine
- Created: 2024-06-30T08:27:51.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-08-01T15:58:37.000Z (7 months ago)
- Last Synced: 2024-11-19T19:02:23.820Z (3 months ago)
- Topics: blockchain, blockchain-nodes, javascript, jwt, mining, mining-rewards, model-view-controller, mongodb, nodejs, react-vite, redis-server, scss, secure-server, separation-of-concerns, tdd, transaction-management, validation, vitest
- Language: JavaScript
- Homepage:
- Size: 27.2 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Go-Chain
Go-Chain is a custom cryptocurrency blockchain implementation with transaction management and validation. This project includes the following features and components. :point_down:
## Features
### Blockchain Implementation :bricks:
- A custom cryptocurrency blockchain.
- Transaction management and validation.
### Transaction Pool :water_polo:
- Managed transactions before adding them to a block.
- Created and tracked reward transactions in the transaction pool.
### Validation :white_check_mark:
- Validated transactions to ensure they follow specified rules.
### Networking :magnet:
- Supported multiple nodes with blockchain synchronization.
- Utilized Redis for network communication.
### Database :floppy_disk:
- Stored the blockchain, blocks and transactions in a MongoDB database.
### Security :closed_lock_with_key:
- Implemented user registration and login.
- Used JSON Web Tokens (JWT) for user validation.
- Stored user information in MongoDB.
### Client Application :balloon:
- Developed a client application using React with Vite.
- Enabled the creation of new transactions.
- Listed transactions and blocks.
- Provided functionality to mine blocks with transactions.
### Best Practices :crystal_ball:
- TDD for transaction management.
- Followed best practices: Clean Code, Separation of Concerns (SOC) and Model-View-Controller (MVC).
- Secured the server against various attacks, including NoSQL injections, DDOS and XSS attempts.
## Installation :scroll:
To run this project locally, follow these steps:
1. **Clone the repository:**
```sh
git clone https://github.com/codebatine/gochain.git
cd gochain
```
2. **Install dependencies for both backend and frontend:**
```sh
cd backend
npm i
cd ../frontend
npm i
```
3. **Run Redis server:**
```sh
redis-server
```
4. **Set up MongoDB:**
Make sure you have MongoDB installed and running on your local machine.
5. **Add environment variables:**
Create a file named `.env` in the `backend/config` directory with the following content:
```env
NODE_ENV=development
PORT=5000
MONGO_URI=your_mongo_uri_here
JWT_SECRET=your_jwt_secret_here
JWT_TTL=90d
JWT_COOKIE_TTL=90d
REDIS_HOST=localhost
REDIS_PORT=6379
```
6. **Start the backend and frontend servers:**
Open two terminal windows or tabs and run the following commands in each:
**In the first terminal (backend):**
```sh
cd backend
npm run dev
```
**In the second terminal (frontend):**
```sh
cd frontend
npm run dev
```
7. **Run tests in backend:**
To run tests for the backend, use the following command:
```sh
cd backend
npm test
```
## Usage :flamingo:
1. **Register and log in:**
- Create a new user account and log in to access the blockchain features.
2. **Create transactions:**
- Use the client application to create and send new transactions.
3. **Mine blocks:**
- Mine blocks to add transactions to the blockchain and receive rewards.
4. **View blockchain:**
- Explore the blockchain, view transactions and monitor blocks.
## Screenshots :camera_flash:
Here are some screenshots of the Go-Chain application in action:
### Registration and Login
### Creating a Transaction
### Viewing the Blockchain
