Skip to content

authentication

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

Authentication Guide

Learn how to authenticate and manage your account in Intelligent IDE.

User Registration

Getting a Verification Code

Before registering, youA1: The main goal is to create an intelligent IDE for educational environments with interactive notebooks and collaborative features.

Q2: How can I contribute to the project? A2: You can contribute by following our contributing guidelines, submitting pull requests, and reporting issues.d to obtain a verification code:

  1. Use the command intelligent-ide.register in VS Code
  2. Enter your email address when prompted
  3. Check your email for a 6-digit verification code (valid for 5 minutes)

Completing Registration

After receiving your verification code:

  1. Enter the verification code in the extension
  2. Choose a username and password
  3. Select your role (Teacher or Student)
  4. Complete the registration process

Registration Response:

  • Success: You'll receive an authentication token automatically
  • Token expires in 24 hours

User Login

Logging In

  1. Open Command Palette (Ctrl+Shift+P / Cmd+Shift+P)
  2. Type intelligent-ide.login
  3. Enter your username and password

Login Response:

  • Success: Authentication token provided (24-hour validity)
  • Error: Check credentials and try again

Managing Your Account

Viewing Profile Information

Use the user management features to view your profile:

  • Username
  • Email address
  • User role (Teacher/Student)
  • Account creation date

Updating Account Information

You can update your account using the intelligent-ide.update command:

  • Change username
  • Update password
  • Modify other profile information

Note: Email address cannot be changed after registration.

Authentication Tokens

How Tokens Work

  • Tokens are automatically included in API requests
  • Tokens expire after 24 hours
  • The extension handles token storage and management

Token Expiration

When your token expires:

  1. You'll be prompted to log in again
  2. Use the login command to get a new token
  3. Your session will be restored

Security Best Practices

  • Keep your credentials secure
  • Log out when using shared computers
  • Report any suspicious activity to the development team

Troubleshooting Authentication

Common Issues:

  1. Email verification code not received

    • Check spam/junk folder
    • Ensure email address is correct
    • Wait 5 minutes before requesting a new code
  2. Login failed

    • Verify username and password
    • Ensure account is registered
    • Check internet connection
  3. Token expired

    • Use the login command to get a new token
    • Check system time is correct

For additional help, see the Troubleshooting Guide.

Table of Contents

Getting Started

To get started, please review the Project Overview to understand the goals and objectives of our project.

If you have any questions, feel free to reach out to any of the team members listed in the Team Members section.

Happy collaborating!


### ProjectOverview.md
```markdown
# Project Overview

## Project Goals
- Define the main objectives of the project.
- Outline the expected outcomes and deliverables.

## Timeline
- Project Start Date: May 2025
- Key Milestones: Alpha release, Beta testing, Final deployment
- Project End Date: May 2025

TeamMembers.md

# Team Members

| Name          | Role                | Contact Information   |
|---------------|---------------------|-----------------------|
| Alice Smith   | Project Manager     | team-lead@intelligent-ide.project     |
| Bob Johnson   | Developer           | developer@intelligent-ide.project       |
| Carol White   | Designer            | designer@intelligent-ide.project     |

MeetingNotes.md

# Meeting Notes

## Meeting Date: May 2025
### Attendees:
- Alice Smith
- Bob Johnson
- Carol White

### Agenda:
1. Project updates
2. Discuss challenges
3. Next steps

### Notes:
- Project progress discussion and technical implementation updates

Resources.md

# Resources

- [Project Repository](https://github.com/your-repo)
- [Documentation](https://docs.yourproject.com)
- [Design Assets](https://drive.google.com/your-design-assets)

FAQs.md

# Frequently Asked Questions

## Q1: What is the main goal of the project?
A1: The main goal is to [insert goal].

## Q2: How can I contribute to the project?
A2: You can contribute by [insert contribution guidelines].

Contributing.md

# Contributing to the Project

We welcome contributions from all team members! Here’s how you can help:

1. **Fork the repository**: Create your own copy of the project.
2. **Make changes**: Implement your changes in a separate branch.
3. **Submit a pull request**: Once you’re ready, submit a pull request for review.

Final Steps

  • Ensure that each markdown file is saved in the appropriate directory.
  • Encourage team members to contribute to the wiki by adding their own notes, resources, and updates.
  • Regularly update the wiki to keep it relevant and useful.

Feel free to modify the content and structure according to your team's specific needs!

Clone this wiki locally