Web3 Student Lab 🎓⛓️

Web3 Student Lab is an open-source educational platform that helps students learn blockchain, smart contracts, open-source collaboration, and hackathon project development in one place.

The platform provides interactive tools, coding environments, and guided learning paths designed for beginners and university students.

� Frequently Asked Questions

• New contributors with environment issues can start here: docs/FAQ.md

�🚀 Core Modules

1. Blockchain Learning Simulator: Visually learn how blockchains work (create transactions, mine blocks, view hashes, and see how blocks connect).
2. Smart Contract Playground: Write, run, and test smart contracts directly in your browser. Focuses on Soroban contracts written in Rust.
3. Web3 Learning Roadmap: A guided path spanning programming fundamentals, cryptography, blockchain architecture, smart contracts, and full Web3 applications.
4. Hackathon Project Idea Generator: Overcome coder's block by generating ideas based on technology and sector preferences.
5. Open Source Contribution Trainer: Get hands-on with Git, simulated GitHub issues, and PR exercises to confidently contribute to open source.

🛠 Technology Stack

Frontend

• React / Next.js
• Tailwind CSS
• Monaco Editor

Backend

• Node.js / Express
• PostgreSQL

Blockchain Integration

• Stellar SDK
• Soroban Smart Contracts

🗺️ Visual Roadmap & Milestones

timeline
    title Web3 Student Lab - Development Timeline
    Phase 1: Discovery : Architecture Planning : Concept Validation : UI/UX Wireframing
    Phase 2: Development : Core Modules Build : Smart Contract Playground : Backend Integration
    Phase 3: Deployment : MVP Launch : Beta Testing : University Outreach

Loading

Phase 1: Discovery 🔍

Objective: Define the core platform architecture, validate learning mechanisms, and design the initial curriculum.

• Milestones:
  • Initial repository setup and architecture planning
  • Define Soroban/Stellar learning roadmap
  • UI/UX wireframes for the Blockchain Simulator

Phase 2: Development 🛠️

Objective: Build out the core modules, integrate blockchain functionalities, and develop the interactive playground.

• Milestones:
  • Implement Next.js + Tailwind frontend
  • Integrate Monaco Editor for Smart Contract Playground
  • Set up PostgreSQL and Node.js backend infrastructure

Phase 3: Deployment 🚀

Objective: Launch the MVP, onboard the first cohort of students, and gather metrics for future iterations.

• Milestones:
  • Deploy backend and database to cloud infrastructure
  • Host the frontend application
  • Open the platform for beta testing

📁 Repository Structure

web3-student-lab/
├── contracts/            # Platform smart contracts (e.g., on-chain certificates)
├── frontend/             # Next.js/React frontend application
│   ├── simulator/        # Visual blockchain tools
│   ├── playground/       # In-browser smart contract editor
│   ├── roadmap/          # Learning progress tracking and paths
│   └── ideas/            # Hackathon project generator UI
├── backend/              # Node.js backend application
│   ├── blockchain/       # Interaction with Stellar/Soroban
│   ├── contracts/        # Compilation and execution engine for student code
│   ├── learning/         # Curriculum and progress APIs
│   └── generator/        # Prompt/AI layer for hackathon ideas
└── docs/                 # Documentation and learning materials

🐳 Getting Started with Docker

The easiest way to set up the local development environment (backend and database) is using Docker Compose.

Prerequisites

• Docker
• Docker Compose

Launching the Environment

1. Clone the repository and navigate to the root directory.
2. Run the following command:

   docker compose up --build

3. The backend will be available at http://localhost:8080.
4. The PostgreSQL database will be accessible at localhost:5432.

Useful Commands

• Stop the environment: docker compose down
• View logs: docker compose logs -f
• Restart a specific service: docker compose restart backend

🤝 Rules for Contributors

We love our contributors! This project is being built for students, by students and open-source enthusiasts.

Important: Please add an ETA (no more than 2 days) when expressing interest in an issue to help us keep development moving quickly.

To start contributing:

1. Read our Contribution Guidelines.
2. Review our Security Best Practices.
3. Read the CI/CD Pipeline Guide.
4. Check out our existing Issues or look for the good first issue label.
5. Fork the repository and submit a Pull Request!

📜 License

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