From f4d6232fca0d7facba3edc061307a9733aa36791 Mon Sep 17 00:00:00 2001 From: Lohit Kolluri Date: Thu, 25 Jan 2024 09:58:46 -0800 Subject: [PATCH] Update README.md --- README.md | 42 +++++++++++++++++++++++------------------- 1 file changed, 23 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index fb76742..9c8d37c 100644 --- a/README.md +++ b/README.md @@ -1,56 +1,56 @@ +

CompileVortex

-

A web-based code editor that allows you to compile and run your code in over 40 programming languages. You can also customize your coding environment by choosing from a selection of available themes.

+

CompileVortex is a powerful web-based code editor that empowers you to compile and run your code in over 40 programming languages. Customize your coding environment with ease by choosing from a selection of available themes.

🚀 Demo

-[https://code.lohitkolluri.tech](https://code.lohitkolluri.tech) +Explore the capabilities of CompileVortex at [https://code.lohitkolluri.tech](https://code.lohitkolluri.tech)

🧐 Features

-Here are some of the project's best features: +Here are some of the project's standout features: - Supports 40+ programming languages. - Custom input support. -- Multiple themes. +- Multiple themes for a personalized coding experience.

🛠️ Installation Steps:

-1. Clone the repository: +Follow these steps to get CompileVortex up and running on your local machine: +1. **Clone the repository:** ```bash git clone https://github.com/lohitkolluri/CompileVortex ``` -2. Navigate to the project directory: - +2. **Navigate to the project directory:** ```bash cd CompileVortex ``` -3. Install dependencies: - +3. **Install dependencies:** ```bash - npm install + yarn # or npm install ``` -4. Register on [RapidAPI](https://rapidapi.com/judge0-official/api/judge0-ce/pricing) and obtain your API keys. - -5. Create a `.env` file and add API Keys to `.env` file. +4. **Obtain RapidAPI Keys:** + - Register on [RapidAPI](https://rapidapi.com/judge0-official/api/judge0-ce/pricing) and obtain your API keys. -6. Run the project: +5. **Create a `.env` file:** + - Add API keys to the `.env` file. +6. **Run the project:** ```bash - npm start + yarn start # or npm start ``` -7. Open localhost in your browser: - - [http://localhost:3000](http://localhost:3000) +7. **Open in your browser:** + Visit [http://localhost:3000](http://localhost:3000)

💻 Built with

-Technologies used in the project: +CompileVortex leverages the following technologies: - React.js - TypeScript @@ -61,3 +61,7 @@ Technologies used in the project:

🛡️ License:

This project is licensed under the [MIT License](LICENSE) + +

📝 License

+ +This project is licensed under the [MIT License](LICENSE)