Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lohitkolluri authored Jan 25, 2024
1 parent a26a551 commit f4d6232
Showing 1 changed file with 23 additions and 19 deletions.
42 changes: 23 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,56 @@

<h1 align="center" id="title">CompileVortex</h1>

<p id="description">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.</p>
<p id="description">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.</p>

<h2>🚀 Demo</h2>

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

<h2>🧐 Features</h2>

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.

<h2>🛠️ Installation Steps:</h2>

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)

<h2>💻 Built with</h2>

Technologies used in the project:
CompileVortex leverages the following technologies:

- React.js
- TypeScript
Expand All @@ -61,3 +61,7 @@ Technologies used in the project:
<h2>🛡️ License:</h2>

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

<h2>📝 License</h2>

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

0 comments on commit f4d6232

Please sign in to comment.