You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-[Building for Production](#33-building-for-production)
20
+
-[System Requirements](#31-system-requirements)
21
+
-[Installation Steps](#32-installation-steps)
22
+
-[Building for Production](#33-building-for-production)
20
23
21
24
## 1. Introduction
22
25
23
26
### 1.1 Project Structure
24
-
This repository contains the frontend of the CodeIDE Platform, built with React, TypeScript, and Monaco Editor. The backend, which handles server-side logic, authentication, and API services, is hosted in a separate repository. Visit the backend repository for more details:
27
+
28
+
This repository contains the frontend of the CodeIDE Platform, built with React, TypeScript, and Monaco Editor. The backend, which handles server-side logic, authentication, and API services, is hosted in a separate repository. Visit the backend repository for more details:
The frontend of the CodeIDE Platform provides a responsive, intuitive web-based integrated development environment (IDE) that connects to robust backend services. It enables developers to write, run, and debug code directly in their browsers with a modern, feature-rich interface.
29
35
30
36
### 1.3 Key Features
37
+
31
38
-**Code Editor**: Rich text editing powered by Monaco Editor, featuring syntax highlighting and code completion.
32
39
-**Editor Settings**: Customizable editor options including theme, font size, font family, minimap, and additional settings for a tailored coding experience.
33
40
-**AI Assistant**: Integrated AI-powered assistant in the code editor for real-time coding support, suggestions, and error detection.
@@ -39,6 +46,7 @@ The frontend of the CodeIDE Platform provides a responsive, intuitive web-based
39
46
-**Authentication System**: User login, registration, forgot password, and password reset functionalities.
40
47
41
48
### 1.4 Planned Features
49
+
42
50
-**File Explorer**: Browse and manage project files and directories.
43
51
-**Real-time Collaboration**: Collaborative editing with presence indicators.
44
52
-**Project Management**: Create, manage, and organize coding projects.
@@ -48,31 +56,38 @@ The frontend of the CodeIDE Platform provides a responsive, intuitive web-based
48
56
## 2. Technology Stack
49
57
50
58
### 2.1 Core Libraries
59
+
51
60
-**React**: Library for building user interfaces
52
61
-**TypeScript**: Static typing for JavaScript
53
62
-**React Router DOM**: Declarative routing for React applications
54
63
55
64
### 2.2 State Management
65
+
56
66
-**Redux Toolkit**: State management for the project.
57
67
58
68
### 2.3 UI Framework
69
+
59
70
-**Tailwind CSS**: Utility-first CSS framework
60
71
-**Shadcn UI**: Component library built with Tailwind
61
72
-**Framer Motion**: Animation library for React
62
73
63
74
### 2.4 Code Editor
75
+
64
76
-**Monaco Editor**: Code editor that powers VS Code
65
77
66
78
### 2.5 API Communication
79
+
67
80
-**Axios**: Promise-based HTTP client
68
81
69
82
### 2.6 Development Tools
83
+
70
84
-**Vite**: Next generation frontend tooling
71
85
-**Prettier**: Code formatter
72
86
73
87
## 3. Project Installation Guide
74
88
75
89
### 3.1 System Requirements
90
+
76
91
-**Node.js**: v16.x or higher
77
92
-**npm**: v8.x or higher (or yarn/pnpm)
78
93
-**Git**: For version control
@@ -81,35 +96,40 @@ The frontend of the CodeIDE Platform provides a responsive, intuitive web-based
0 commit comments