Skip to content

Commit

Permalink
Update README.md 📝
Browse files Browse the repository at this point in the history
  • Loading branch information
lohitkolluri committed Jan 19, 2024
1 parent d64acc9 commit 82079a7
Showing 1 changed file with 30 additions and 14 deletions.
44 changes: 30 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
# CompileVortex
<h1 align="center" id="title">CompileVortex</h1>

⚡️ CompileVortex is 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 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>

## Table of Contents
<h2>🚀 Demo</h2>

- [Features](#features)
- [Installation and Setup](#installation-and-setup)
[https://code.lohitkolluri.tech](https://code.lohitkolluri.tech)

## Features
<h2>🧐 Features</h2>

- Compile and execute code in 40+ programming languages.
- Switch themes from a list of available themes.
Here are some of the project's best features:

## Installation and Setup
- Supports 40+ programming languages.
- Custom input support.
- Multiple themes.

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

1. Clone the repository:

Expand All @@ -34,14 +36,28 @@

4. Register on [RapidAPI](https://rapidapi.com/judge0-official/api/judge0-ce/pricing) and obtain your API keys.

5. Create a `.env` file.

6. Add the API keys to the `.env` file.
5. Create a `.env` file and add API Keys to `.env` file.

7. Run the project:
6. Run the project:

```bash
npm start
```

The project will be accessible at `http://localhost:3000`.
7. Open localhost in your browser:

[http://localhost:3000](http://localhost:3000)

<h2>💻 Built with</h2>

Technologies used in the project:

- React.js
- TypeScript
- Axios
- Tailwind CSS
- Monaco Editor

<h2>🛡️ License:</h2>

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

0 comments on commit 82079a7

Please sign in to comment.