Skip to content

Latest commit

 

History

History
117 lines (78 loc) · 2.59 KB

readme.md

File metadata and controls

117 lines (78 loc) · 2.59 KB

VolunChain

Innovating Volunteering with Blockchain 🚀

VolunChain is a blockchain-powered platform that connects volunteers with organizations in a transparent, decentralized, and efficient way. Our mission is to make volunteering more accessible, secure, and rewarding for everyone.

🌟 Key Features

  • Opportunity Connection: Match volunteers with organizations.
  • NFT Certifications: Reward achievements with unique digital collectibles.
  • Tokenized Rewards: Incentivize volunteers with blockchain tokens.
  • Community Governance: A planned DAO model for user-driven decisions.
  • Transparency & Security: All data and transactions are verifiable and secure.
  • Global Reach: Designed to connect communities worldwide.

🌟 Important!

If you found this repository helpful or contributed to it, please give it a ⭐ on GitHub!
Your support helps us grow and motivates us to continue improving VolunChain. 🙌

🛠️ Technologies Used

  • Frontend: React, Next.js.
  • Backend: Node.js, Express, TypeORM.
  • Blockchain: Stellar, Rust.
  • Database: PostgreSQL, TypeORM.
  • Containers: Docker for consistent environments.

🚀 Installation

Follow these steps to set up the backend locally:

Prerequisites:

  • Node.js (v18 or higher)
  • Docker & Docker Compose

Steps:

  1. Clone the Repository:

    git clone https://github.com/your-repo/volunchain-backend.git
cd volunchain-backend

  2. Set Up Environment Variables: Create a .env file:

    DATABASE_URL=postgresql://volunchain:volunchain123@localhost:5432/volunchain
PORT=3000
JWT_SECRET=your-jwt-secret

  3. Start PostgreSQL with Docker:

    docker-compose up -d

  4. Install Dependencies:

    npm install

  5. Run the Development Server:

    npm run dev

🤝 How to Contribute

  1. Fork the repository.

  2. Create a branch for your changes:

    git checkout -b feature/new-feature

  3. Commit your changes: i. The project uses pre-commit hooks to ensure code quality. They will automatically:

    • Run ESLint to check code style
    • Run Prettier to format code
    • Run tests to ensure everything works

    ii. For urgent commits that need to bypass checks:

    git commit -m "urgent fix" --no-verify
    git commit -m "Add new feature"

  4. Push and create a Pull Request.

📄 License

This project is licensed under the MIT License.

🎉 Empowering Volunteerism, One Block at a Time.