Skip to content
ABHISEK PANDA edited this page Aug 22, 2025 · 1 revision

Welcome to the Dev-Elevate wiki!

1. ๐Ÿ  Home (Landing Page)

Title: Welcome to the Dev-Elevate Wiki!

Content:

  • Short intro about the project
  • Vision + Mission
  • Links to other wiki pages

Example:

Dev-Elevate is a platform built to help students and developers upskill with interactive learning hubs, placement preparation, and career resources.

๐Ÿš€ Our mission: Empower learners to crack interviews and grow into industry-ready developers.

๐Ÿ”— Quick Links:


2. ๐Ÿ“Œ Project Overview

  • High-level description of Dev-Elevate

  • Core modules:

    • Placement Preparation Arena
    • Learning Hubs (DSA, MERN, etc.)
    • Career Growth Resources
  • Tech Stack Used (MERN, Tailwind, etc.)

  • Target audience (students, job seekers, developers)


3. โš™๏ธ Setup Guide

Step-by-step instructions for contributors & users.

Local Development Setup

  1. Clone repo

    git clone https://github.com/<username>/dev-elevate.git
    cd dev-elevate
    cd client
    cd server
  2. Install dependencies

    npm install
  3. Setup .env file with DB + API keys

  4. Run development server

    npm run dev

Backend Setup

  • MongoDB configuration
  • Express routes structure

Frontend Setup

  • React/Next.js setup
  • Tailwind CSS setup

4. ๐Ÿ“š Learning Hubs

Subpages:

  • DSA Learning Hub

    • Arrays, Strings, Linked Lists, Trees, Graphs, DP
    • Interactive modules with code editor, notes, reviews, progress tracking
  • MERN Stack Hub

    • HTML, CSS, JS, React, Node, MongoDB
    • Hands-on coding environment
  • Placement Prep Arena

    • Job Listings + Apply Flow
    • Mock Interview Q&A
    • Resume & Skill-building resources

Each page should have:

  • Modules overview
  • Features (Notes, Code, Reviews, Progress)
  • Screenshots (optional)

5. ๐Ÿ‘จโ€๐Ÿ’ป Contribution Guide

  • Fork, Branch, Commit, PR process
  • Contribution rules (what to do / not do)
  • Example commit message format
  • Labels used in issues (bug, enhancement, feature, etc.)

6. ๐Ÿ“‚ Data Models & API

Document backend structure:

Example:

User Model

{
  username: String,
  email: String,
  password: String,
  role: "student" | "admin"
}

Notes Model

{
  userId,
  topicId,
  content: String,
  updatedAt: Date
}

Review Model

{
  userId,
  topicId,
  rating: Number,
  comment: String,
  createdAt: Date
}

7. ๐Ÿš€ Roadmap

Planned features:

  • โœ… Placement Preparation Arena
  • โœ… DSA Learning Hub (in progress)
  • ๐Ÿ”„ MERN Learning Hub (coming soon)
  • ๐Ÿ”„ Auto-comment workflows for Issues/PRs
  • ๐Ÿ”ฎ Future: AI-powered code mentor

8. ๐Ÿ› Issues & PR Workflow

  • How issues should be created (with templates)
  • PR checklist before submitting
  • Autocomment GitHub Actions workflow (explained)

9. ๐Ÿ“Š Current Status

  • Version: v1.0.0-beta
  • Live deployment link (if any, e.g., Vercel/Netlify)
  • Known issues / limitations

10. ๐Ÿ™Œ Community & Credits

  • Team members / contributors list
  • Acknowledgments
  • How to join Dev-Elevate as a contributor