-
Notifications
You must be signed in to change notification settings - Fork 0
getting started
Mile Shi edited this page May 26, 2025
·
2 revisions
Welcome to Intelligent IDE! This guide will help you get started with our VS Code extension for educational collaboration.
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
Before installing Intelligent IDE, ensure you have:
- VS Code: Download here
- Backend services running (for developers)
Currently, Intelligent IDE is in development. To install:
- Clone the project repository
- Navigate to the
frontend/intelligent-ide
directory - Run
npm install
to install dependencies - Press
F5
to launch the extension in development mode
- Open the Command Palette (
Ctrl+Shift+P
on Windows/Linux,Cmd+Shift+P
on Mac) - Type
intelligent-ide.login
and press Enter - Enter your credentials or register a new account
Once logged in, you can:
- Use the command
intelligent-ide.register
to create an account if you're a teacher - Create courses through the course management interface
- Invite students to join your courses
- Learn about authentication
- Explore course management features
- Try collaborative editing
- Check out the notebook features
If you encounter any issues:
- Check our Troubleshooting Guide
- Review the FAQ section
- Contact the development team (contact information to be added)
- Team Members
- Meeting Notes
- Resources
- FAQs
- Contributing
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.
-
Getting_Started.md
# Getting Started Instructions on how to set up the project locally, including prerequisites and installation steps.
-
Team_Members.md
# Team Members List of team members, their roles, and contact information.
-
Meeting_Notes.md
# Meeting Notes A log of meeting notes, agendas, and action items.
-
Resources.md
# Resources Links to relevant documentation, tools, and libraries that the team is using.
-
FAQs.md
# Frequently Asked Questions A collection of common questions and answers related to the project.
-
Contributing.md
# Contributing Guidelines for contributing to the project, including coding standards and submission processes.
- 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!
🏠 Home
- Getting Started
- Installation Guide
- Authentication
- Course Management
- Collaborative Editing
- Assignments
- Notebook Features
- File Management
- Troubleshooting
- Setup & Development
- Architecture Overview
- Backend Development
- Frontend Development
- API Reference
- Contributing
- Deployment