Update README and EditorArea components with project description and functionalities
This commit is contained in:
@@ -515,21 +515,31 @@ const EditorArea = ({
|
||||
case "README.md":
|
||||
return `# VS Code Clone Project
|
||||
|
||||
## Overview
|
||||
This is a simple VS Code clone built with React and Monaco Editor.
|
||||
## Authors
|
||||
- Arnab Bhowmik
|
||||
- Ishika Bhoyar
|
||||
|
||||
## Features
|
||||
- File tree navigation
|
||||
- Tab management
|
||||
- Code editing with Monaco Editor
|
||||
- Syntax highlighting
|
||||
## Description
|
||||
This project is a VS Code Clone built with React and Monaco Editor. It features a file tree navigation, tab management, code editing with syntax highlighting, and a terminal panel for running code. It mimics the core functionalities of Visual Studio Code in a browser-based environment.
|
||||
|
||||
## Frontend Functionalities
|
||||
- Built with React and Monaco Editor.
|
||||
- File tree navigation for managing files and folders.
|
||||
- Tab management for opening multiple files simultaneously.
|
||||
- Code editing with syntax highlighting and language support.
|
||||
- Terminal panel for running code and viewing output.
|
||||
- Persistent file structure and content using localStorage.
|
||||
|
||||
## Backend Functionalities
|
||||
- Built with Go and Docker for secure code execution.
|
||||
- Supports multiple programming languages (Python, Java, C/C++).
|
||||
- Executes code in isolated Docker containers with resource limits.
|
||||
- RESTful API for submitting code, checking status, and retrieving results.
|
||||
- Job queue system for managing concurrent executions.
|
||||
- Enforces timeouts and resource limits for security and performance.
|
||||
`;
|
||||
|
||||
## Getting Started
|
||||
1. Create a new file using the + button in the sidebar
|
||||
2. Edit your code in the editor
|
||||
3. Save changes using the save button
|
||||
|
||||
Happy coding!`;
|
||||
default:
|
||||
return "";
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user