CodedForum 🚀

CodedForum is a fully-featured Web3 Learn-to-Earn community forum where users share knowledge and earn cryptocurrency rewards.

🌟 Overview

CodedForum is a decentralized knowledge-sharing platform that incentivizes quality contributions through blockchain-based rewards. Users earn tokens for creating posts, commenting, and receiving upvotes, creating a vibrant, engaged community.

✨ Features

🎯 Core Features

• ✅ Web3 Wallet Integration - Seamless MetaMask connection
• ✅ Learn-to-Earn System - Earn tokens for contributions
• ✅ Forum Functionality - Create posts, comment, and discuss
• ✅ Voting System - Upvote/downvote posts and comments
• ✅ Reputation Tracking - Build your on-chain reputation
• ✅ Leaderboard - Compete with top contributors
• ✅ Token Rewards - Claim your earned CFT tokens
• ✅ IPFS Integration - Decentralized content storage
• ✅ Smart Contracts - ERC20 token with reward mechanisms
• ✅ User Profiles - Track your stats and achievements

💰 Earning Mechanism

• Create Posts: 5 reputation points
• Comment: 2 reputation points + 1 token
• Receive Upvotes: 1 reputation point + 0.5 tokens

🛠️ Tech Stack

Frontend

• React.js - Modern UI framework
• Ethers.js - Ethereum blockchain interaction
• React Router - Client-side routing
• CSS3 - Responsive design

Backend

• Node.js - Server runtime
• Express.js - Web framework
• IPFS - Decentralized storage
• In-memory storage - Development database

Blockchain

• Solidity 0.8.20 - Smart contract language
• Hardhat - Development environment
• OpenZeppelin - Secure contract libraries
• ERC20 Standard - Token implementation

🚀 Quick Start

Prerequisites

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

Installation

1. Clone the repository

git clone https://github.com/codedforum/CodedForum-community.git
cd CodedForum-community

2. Install dependencies

npm run install-all

3. Configure environment

cp .env.example .env
# Edit .env with your configuration

4. Run the application

npm run dev-all

5. Access the app

• Frontend: http://localhost:3000
• Backend API: http://localhost:5000

For detailed setup instructions, see SETUP.md

📚 Documentation

• Setup Guide - Complete installation and configuration guide
• Architecture - System architecture and design decisions
• API Documentation - Backend API reference

🏗️ Project Structure

CodedForum-community/
├── client/              # React frontend application
│   ├── src/
│   │   ├── components/  # React components
│   │   ├── utils/       # Utility functions
│   │   └── App.js       # Main app component
│   └── package.json
├── server/              # Express backend
│   ├── index.js         # Main server file
│   └── utils/           # Server utilities
├── contracts/           # Smart contracts
│   ├── CodedForumToken.sol
│   └── scripts/deploy.js
├── package.json
└── README.md

🔌 API Endpoints

Users

• POST /api/users/register - Register new user
• GET /api/users/:walletAddress - Get user profile

Posts

• GET /api/posts - Get all posts
• POST /api/posts - Create new post
• GET /api/posts/:id - Get single post
• POST /api/posts/:id/comments - Add comment
• POST /api/posts/:id/vote - Vote on post

Rewards

• GET /api/rewards/leaderboard - Get top users
• POST /api/rewards/claim - Claim rewards

🎨 Screenshots

Home Page

Beautiful landing page with post listings and category filters

Create Post

Intuitive post creation with reward information

Leaderboard

Track top contributors and earning statistics

Profile

Personal dashboard with token balance and activity

🗺️ Roadmap

✅ Phase 1 - MVP (Q2 2025)

• Forum functionality
• Web3 wallet integration
• Token rewards system
• IPFS integration
• MongoDB integration
• JWT authentication

🔄 Phase 2 - Enhancement (Q3 2025)

• On-chain reputation storage
• NFT achievement badges
• Token staking
• Advanced analytics

🔮 Phase 3 - Expansion (Q4 2025)

• Mobile application
• Governance system
• Multi-chain support
• DAO formation

🤝 Contributing

We welcome contributions! Please follow these steps:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add 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.

🔗 Links

• Website: [Coming Soon]
• Twitter: [Coming Soon]
• Discord: [Coming Soon]
• Documentation: docs.codedforum.io

💬 Support

• 📧 Email: support@codedforum.io
• 💬 Discord: Join our community
• 🐛 Issues: GitHub Issues

🙏 Acknowledgments

• OpenZeppelin for secure smart contract libraries
• Ethereum community for Web3 standards
• React community for amazing tools
• All contributors and supporters

---

Built with ❤️ for the Web3 community

Empowering knowledge sharing through blockchain technology