Package Exports
- bvc-eth
- bvc-eth/bin/bvc.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (bvc-eth) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
π Blockchain Version Control (BVC)
A decentralized version control system inspired by Git, but powered by blockchain and IPFS.
β¨ Features
- π Decentralized: No central server required
- βοΈ Blockchain-powered: Immutable commit history on Ethereum
- π IPFS storage: Decentralized file storage
- π Cryptographically secure: SHA256 file hashing
- π» Git-like CLI: Familiar commands and workflows
π¦ Installation
Global Installation (Recommended)
npm install -g bvc-ethLocal Installation
npm install bvc-ethManual Installation
git clone https://github.com/Lviffy/BVC.git
cd BVC
npm install
npm link # or use: node bin/bvc.jsπ Quick Start
1. Configure BVC
bvc-eth config --setup2. Create a Repository
bvc-eth init my-project
cd my-project3. Add Files and Commit
echo "console.log('Hello BVC!');" > index.js
bvc-eth add index.js
bvc-eth commit -m "Initial commit"4. Push to Blockchain
bvc-eth push5. View History
bvc-eth log6. Collaborate
# Share your repository ID with others
bvc-eth list --mine
# Others can clone your repository
bvc-eth clone <your-repo-id>
# Pull latest changes
bvc-eth pullπ Commands
| Command | Description | Status |
|---|---|---|
bvc-eth init [name] |
Create new repository | β Working |
bvc-eth config |
Configure wallet/blockchain | β Working |
bvc-eth add <files> |
Stage files for commit | β Working |
bvc-eth commit -m "msg" |
Create commit with IPFS upload | β Working |
bvc-eth status |
Show repository status | β Working |
bvc-eth log |
View commit history | β Working |
bvc-eth push |
Push commits to blockchain | β Working |
bvc-eth pull |
Pull commits from blockchain | β Working |
bvc-eth clone <id> |
Clone repository from blockchain | β Working |
bvc-eth checkpoint |
Create commit batches | β Working |
bvc-eth list |
List all repositories | β Working |
βοΈ Configuration
BVC requires configuration for blockchain and IPFS integration:
bvc config --setupRequired settings:
- Private Key: Your wallet private key
- RPC URL: Blockchain RPC endpoint (Sepolia, Mainnet, etc.)
- IPFS Endpoint: IPFS node URL
ποΈ Architecture
βββββββββββββββββββ ββββββββββββββββββββ βββββββββββββββββββ
β BVC CLI βββββΆβ Smart Contract βββββΆβ Blockchain β
β (Commander) β β (Solidity) β β (Ethereum) β
βββββββββββββββββββ ββββββββββββββββββββ βββββββββββββββββββ
β β β
βΌ βΌ βΌ
βββββββββββββββββββ ββββββββββββββββββββ βββββββββββββββββββ
β Local Storage β β File Hashing β β IPFS β
β (.bvc/) β β (SHA256) β β (Distributed) β
βββββββββββββββββββ ββββββββββββββββββββ βββββββββββββββββββπ§ͺ Testing
npm testπ License
MIT Β© Lviffy
π€ Contributing
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
π Support
- π§ Issues: GitHub Issues
- π Documentation: Command Guide
- π Website: GitHub Repository
β οΈ Note: This is an early-stage project. Use at your own risk and test thoroughly before production use.