Skip to content

thechessguy2400-design/EducredChain

Repository files navigation

EduCred Chain

License: MIT GitHub stars GitHub issues

A decentralized platform for secure, verifiable, and tamper-proof educational credentials using blockChain technology. Built with React, TypeScript, and Web3 technologies, EduCred Chain provides a secure and transparent way to handle academic credentials.

Features

  • Secure Wallet Integration - Connect with MetaMask and manage your credentials securely
  • Blockchain-Verified Credentials - Store and verify credentials on the Polygon Mumbai testnet
  • Responsive Design - Works seamlessly on desktop and mobile devices
  • Modern Tech Stack - Built with React, TypeScript, Vite, and Tailwind CSS
  • Easy Verification - Instantly verify the authenticity of any credential
  • IPFS Storage - Decentralized storage for credential documents

Getting Started :

Prerequisites

  • Node.js (v16 or later)
  • npm or yarn
  • MetaMask browser extension

Installation

  1. Clone the repository

    git clone https://github.com/Sudhss/EducredChain.git
    cd EducredChain
  2. Install dependencies

    npm install
    # or
    yarn install
  3. Start the development server

    npm run dev
    # or
    yarn dev
  4. Open in your browser

    http://localhost:5173
    

Usage

  1. Connect Your Wallet

    • Click the "Connect Wallet" button in the top-right corner
    • Sign in with your MetaMask wallet
    • Switch to the Polygon Mumbai testnet when prompted
  2. Manage Credentials

    • Upload new educational credentials
    • View your credential collection
    • Share verifiable credentials with others
  3. Verify Credentials

    • Check the authenticity of any credential
    • View detailed credential information

Tech Stack

  • Frontend: React, TypeScript, Vite
  • Styling: Tailwind CSS
  • Blockchain: Ethereum, Polygon (Mumbai Testnet)
  • Web3: ethers.js, Web3Modal
  • Storage: IPFS (via NFT.Storage)
  • UI Components: Lucide Icons, Headless UI

Project Structure

src/
├── components/       # Reusable UI components
├── contexts/        # React contexts for state management
├── pages/           # Application pages
├── services/        # API and blockchain services
└── utils/           # Utility functions and helpers

Smart Contracts

Smart contracts are deployed on the Polygon Mumbai testnet. The contracts handle:

  • Credential minting and management
  • Ownership verification
  • Credential status updates

Contributing

Contributions are welcome! Please read our Contributing Guidelines to get started.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

  • MetaMask for the wallet integration
  • Polygon for the scalable blockchain infrastructure
  • IPFS for decentralized storage
  • Vite for the amazing development experience

Contact

Project Link: https://github.com/Sudhss/EducredChain

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors