diff --git a/Frontend/README.md b/Frontend/README.md index 10f1307..03e7d9f 100644 --- a/Frontend/README.md +++ b/Frontend/README.md @@ -1,13 +1,24 @@ -# VSCode Clone with React and Vite +# VS Code Clone Project -This project is a VSCode-like code editor built with React and Vite. It features a customizable UI with an activity bar, sidebar, editor area, panel, and status bar, mimicking the look and feel of Visual Studio Code. +## Authors +- Arnab Bhowmik +- Ishika Bhoyar -## Features +## 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. -- **Activity Bar**: Switch between different views like Explorer, Search, Source Control, etc. -- **Sidebar**: Displays file explorer, search results, and source control information. -- **Editor Area**: Code editor with syntax highlighting and multiple tabs. -- **Panel**: Terminal, Problems, and Output views. -- **Status Bar**: Displays status information and provides quick actions. +## 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. -## Project Structure +## 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. diff --git a/Frontend/src/components/EditorArea.jsx b/Frontend/src/components/EditorArea.jsx index 32e09e8..a0610b5 100644 --- a/Frontend/src/components/EditorArea.jsx +++ b/Frontend/src/components/EditorArea.jsx @@ -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 ""; }