Skip to content

Commit 6cfbe30

Browse files
committed
updated readme
1 parent a4e1cd1 commit 6cfbe30

File tree

3 files changed

+57
-33
lines changed

3 files changed

+57
-33
lines changed

front-end/README.md

Lines changed: 40 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,60 @@
1-
# Getting Started with Create React App
1+
# Code Verse Frontend
22

3-
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
3+
## Features
44

5-
## Available Scripts
5+
- Multiple tabs for editing multiple files simultaneously
6+
- Integrated terminal
7+
- Search and replace functionality
8+
- Code folding
9+
- Import files and folders from your local system
10+
- Download files and folders to your local system
11+
- Persistent storage of files and folders
12+
- Autocomplete suggestions
613

7-
In the project directory, you can run:
14+
<br>
815

9-
### `npm start`
16+
## Themes
1017

11-
Runs the app in the development mode.\
12-
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
18+
The code editor app offers multiple themes to customize the editor's appearance. Themes provide different color schemes and styles, allowing you to personalize the coding environment. Here are some available themes:
1319

14-
The page will reload if you make edits.\
15-
You will also see any lint errors in the console.
20+
- Dark Theme: A sleek and modern dark-themed editor with a dark background and vibrant syntax highlighting colors. It is easy on the eyes and suitable for coding in low-light conditions.
1621

17-
### `npm test`
22+
- Light Theme: A clean and bright light-themed editor with a white background and contrasting syntax highlighting colors. It offers a refreshing and professional coding experience.
1823

19-
Launches the test runner in the interactive watch mode.\
20-
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
24+
- Monokai Theme: A popular theme inspired by the Monokai color scheme, known for its vibrant and visually appealing syntax highlighting. It provides a stylish and energetic coding environment.
2125

22-
### `npm run build`
26+
- Solarized Theme: The Solarized theme is a balanced and well-thought-out color scheme designed for code legibility. It offers both light and dark variants, ensuring comfortable coding in different lighting conditions.
2327

24-
Builds the app for production to the `build` folder.\
25-
It correctly bundles React in production mode and optimizes the build for the best performance.
28+
- Dracula Theme: A dark-themed editor inspired by the popular Dracula color scheme. It features a dark background with contrasting syntax highlighting colors, creating an atmospheric and visually appealing coding environment.
2629

27-
The build is minified and the filenames include the hashes.\
28-
Your app is ready to be deployed!
30+
- Night Owl Theme: A sophisticated dark theme with carefully selected colors for optimal code readability. The Night Owl theme provides a pleasant contrast between the background and syntax elements, making code stand out while reducing eye strain.
2931

30-
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
32+
You can easily switch between themes within the app to find the one that suits your preferences.
3133

32-
### `npm run eject`
34+
<br>
3335

34-
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
36+
## Getting Started
3537

36-
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
38+
1. Clone the repository:
3739

38-
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
40+
```bash
41+
git clone https://github.com/vickyguptaa7/Code-Verse.git
42+
```
3943

40-
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
44+
2. Change to the `back-end` directory:
4145

42-
## Learn More
46+
```bash
47+
cd react-code-editor
48+
```
4349

44-
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
50+
3. Install the dependencies:
4551

46-
To learn React, check out the [React documentation](https://reactjs.org/).
52+
```bash
53+
npm install
54+
```
55+
56+
4. Start the development server:
57+
```bash
58+
npm run dev
59+
```
60+
5. Open your favorite web browser and visit `http://localhost:3000` to access the code verse editor.

front-end/src/Assets/Data/FileFolder.data.tsx

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,17 @@ import {
99
import { uniqueIdGenerator } from "../../library/uuid/uuid.lib";
1010

1111
const README = `#Introduction
12-
This web app is a clone of the popular code editor, Code Verse.
13-
It provides a similar interface and features to Code Verse, but can be accessed directly from your web browser.
12+
Welcome to CodeVerse, an online code editor and compiler designed to support various programming languages including Java, C++, Python, and more. With CodeVerse, you can write, edit, and execute your code seamlessly within a web-based environment.
1413
1514
#FEATURES
16-
1.Multiple tabs for editing multiple files simultaneously
17-
2.Integrated terminal
18-
3.Search and replace functionality
19-
4.Code folding
20-
5.Autocomplete suggestions`;
15+
- Multiple tabs for editing multiple files simultaneously
16+
- Integrated terminal
17+
- Search and replace functionality
18+
- Code folding
19+
- Autocomplete suggestions
20+
- Import files and folders from your local system
21+
- Download files and folders to your local system
22+
- Persistent storage of files and folders`;
2123

2224
const uniqueId = uniqueIdGenerator();
2325

readme.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,16 @@
2626

2727
- **Code Folding**: When dealing with large code files, readability becomes crucial. CodeVerse allows you to collapse or fold sections of code, such as functions, classes, or loops, to hide their details temporarily. This feature helps you focus on specific parts of your code and improves overall code organization.
2828

29+
- **Import files and folders**: I integrated a feature that allows me to import files and folders from my local system directly into the code editor web app. This makes it seamless to integrate my existing codebase into the editor.
30+
31+
- **Download files and folders**: Another convenient feature I added is the ability to download files and folders from the web app. This functionality makes it effortless to save and share code with others.
32+
33+
- **Persistent data**: One critical aspect I focused on was data persistence. The code editor automatically saves my work, ensuring that I never lose progress, even if I close the app or refresh the browser.
34+
2935
- **Autocomplete Suggestions**: CodeVerse offers intelligent autocomplete suggestions as you type. The app analyzes your code context and provides suggestions for variables, functions, and other relevant code snippets. This feature saves time, reduces typos, and helps you write code more efficiently.
3036

37+
38+
3139
<br>
3240

3341
## Technologies Used

0 commit comments

Comments
 (0)