Skip to content

getting started

Mile Shi edited this page May 26, 2025 · 2 revisions

Getting Started with Intelligent IDE

Welcome to Intelligent IDE! This guide will help you get started with our VS Code extension for educational collaboration.

What is Intelligent IDE?

Intelligent IDE is a comprehensive VS Code extension designed for educational environments that provides:

  • Course creation and management
  • Real-time collaborative editing
  • Interactive notebook interface
  • Assignment submission system
  • Integrated chat for course communication

Quick Start

1. Installation Prerequisites

Before installing Intelligent IDE, ensure you have:

  • VS Code: Download here
  • Backend services running (for developers)

2. Installing the Extension

Currently, Intelligent IDE is in development. To install:

  1. Clone the project repository
  2. Navigate to the frontend/intelligent-ide directory
  3. Run npm install to install dependencies
  4. Press F5 to launch the extension in development mode

3. First Login

  1. Open the Command Palette (Ctrl+Shift+P on Windows/Linux, Cmd+Shift+P on Mac)
  2. Type intelligent-ide.login and press Enter
  3. Enter your credentials or register a new account

4. Creating Your First Course

Once logged in, you can:

  1. Use the command intelligent-ide.register to create an account if you're a teacher
  2. Create courses through the course management interface
  3. Invite students to join your courses

Next Steps

Need Help?

If you encounter any issues:

Important Links

Feel free to explore the pages and contribute to the documentation!


### Suggested Additional Pages

1. **Project_Overview.md**
   ```markdown
   # Project Overview

   Provide a brief description of the project, its goals, and objectives.
  1. Getting_Started.md

    # Getting Started
    
    Instructions on how to set up the project locally, including prerequisites and installation steps.
  2. Team_Members.md

    # Team Members
    
    List of team members, their roles, and contact information.
  3. Meeting_Notes.md

    # Meeting Notes
    
    A log of meeting notes, agendas, and action items.
  4. Resources.md

    # Resources
    
    Links to relevant documentation, tools, and libraries that the team is using.
  5. FAQs.md

    # Frequently Asked Questions
    
    A collection of common questions and answers related to the project.
  6. Contributing.md

    # Contributing
    
    Guidelines for contributing to the project, including coding standards and submission processes.

Tips for Maintaining the Wiki

  • Encourage team members to update the wiki regularly.
  • Use clear and concise language.
  • Organize content logically to make it easy to navigate.
  • Regularly review and update the information to keep it current.

Feel free to modify the content and structure to better fit your team's needs!

Clone this wiki locally