Skip to content

Commit ab2c773

Browse files
committed
docs: add project banner image
1 parent 17a64f2 commit ab2c773

File tree

2 files changed

+53
-33
lines changed

2 files changed

+53
-33
lines changed

README.md

Lines changed: 53 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,40 @@
11
# CodeIDE Platform - Frontend Documentation
22

3+
![CodeIDE Banner](./src/assets/CodeIde%20Banner.png)
4+
35
## Table of Contents
6+
47
1. [Introduction](#1-introduction)
5-
- [Project Structure](#11-project-structure)
6-
- [Overview](#12-overview)
7-
- [Key Features](#13-key-features)
8-
- [Planned Features](#14-planned-features)
8+
- [Project Structure](#11-project-structure)
9+
- [Overview](#12-overview)
10+
- [Key Features](#13-key-features)
11+
- [Planned Features](#14-planned-features)
912
2. [Technology Stack](#2-technology-stack)
10-
- [Core Libraries](#21-core-libraries)
11-
- [State Management](#22-state-management)
12-
- [UI Framework](#23-ui-framework)
13-
- [Code Editor](#24-code-editor)
14-
- [API Communication](#25-api-communication)
15-
- [Development Tools](#26-development-tools)
13+
- [Core Libraries](#21-core-libraries)
14+
- [State Management](#22-state-management)
15+
- [UI Framework](#23-ui-framework)
16+
- [Code Editor](#24-code-editor)
17+
- [API Communication](#25-api-communication)
18+
- [Development Tools](#26-development-tools)
1619
3. [Project Installation Guide](#3-project-installation-guide)
17-
- [System Requirements](#31-system-requirements)
18-
- [Installation Steps](#32-installation-steps)
19-
- [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)
2023

2124
## 1. Introduction
2225

2326
### 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:
29+
2530
- **Backend Repository**: https://github.com/sabbirhosen44/CodeIDE-Backend.
2631

2732
### 1.2 Overview
33+
2834
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.
2935

3036
### 1.3 Key Features
37+
3138
- **Code Editor**: Rich text editing powered by Monaco Editor, featuring syntax highlighting and code completion.
3239
- **Editor Settings**: Customizable editor options including theme, font size, font family, minimap, and additional settings for a tailored coding experience.
3340
- **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
3946
- **Authentication System**: User login, registration, forgot password, and password reset functionalities.
4047

4148
### 1.4 Planned Features
49+
4250
- **File Explorer**: Browse and manage project files and directories.
4351
- **Real-time Collaboration**: Collaborative editing with presence indicators.
4452
- **Project Management**: Create, manage, and organize coding projects.
@@ -48,31 +56,38 @@ The frontend of the CodeIDE Platform provides a responsive, intuitive web-based
4856
## 2. Technology Stack
4957

5058
### 2.1 Core Libraries
59+
5160
- **React**: Library for building user interfaces
5261
- **TypeScript**: Static typing for JavaScript
5362
- **React Router DOM**: Declarative routing for React applications
5463

5564
### 2.2 State Management
65+
5666
- **Redux Toolkit**: State management for the project.
5767

5868
### 2.3 UI Framework
69+
5970
- **Tailwind CSS**: Utility-first CSS framework
6071
- **Shadcn UI**: Component library built with Tailwind
6172
- **Framer Motion**: Animation library for React
6273

6374
### 2.4 Code Editor
75+
6476
- **Monaco Editor**: Code editor that powers VS Code
6577

6678
### 2.5 API Communication
79+
6780
- **Axios**: Promise-based HTTP client
6881

6982
### 2.6 Development Tools
83+
7084
- **Vite**: Next generation frontend tooling
7185
- **Prettier**: Code formatter
7286

7387
## 3. Project Installation Guide
7488

7589
### 3.1 System Requirements
90+
7691
- **Node.js**: v16.x or higher
7792
- **npm**: v8.x or higher (or yarn/pnpm)
7893
- **Git**: For version control
@@ -81,35 +96,40 @@ The frontend of the CodeIDE Platform provides a responsive, intuitive web-based
8196
### 3.2 Installation Steps
8297

8398
1. Clone the repository:
84-
```bash
85-
git clone https://github.com/Md-SabbirHosen/CodeIDE-Frontend.git
86-
cd codeide-frontend
87-
```
99+
100+
```bash
101+
git clone https://github.com/Md-SabbirHosen/CodeIDE-Frontend.git
102+
cd codeide-frontend
103+
```
88104

89105
2. Install dependencies:
90-
```bash
91-
npm install
92-
# or
93-
yarn install
94-
# or
95-
pnpm install
96-
```
106+
107+
```bash
108+
npm install
109+
# or
110+
yarn install
111+
# or
112+
pnpm install
113+
```
97114

98115
3. Start the development server:
99-
```bash
100-
npm run dev
101-
# or
102-
yarn dev
103-
# or
104-
pnpm dev
105-
```
106-
The application will be available at [http://localhost:3000](http://localhost:3000).
116+
```bash
117+
npm run dev
118+
# or
119+
yarn dev
120+
# or
121+
pnpm dev
122+
```
123+
The application will be available at [http://localhost:3000](http://localhost:3000).
107124

108125
### 3.3 Building for Production
126+
109127
To create a production-ready build:
128+
110129
```bash
111130
npm run build
112131
# or
113132
yarn build
114133
# or
115134
pnpm build
135+
```

src/assets/CodeIde Banner.png

331 KB
Loading

0 commit comments

Comments
 (0)