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 d8f02b8 commit 1bdc5c2
Showing 1 changed file with 40 additions and 9 deletions.
49 changes: 40 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,47 @@
# CompileVortex

⚡️ A code editor that compiles and runs your code on the web.
⚡️ 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.

## Table of Contents

- [Features](#features)
- [Installation and Setup](#installation-and-setup)

## Features

## Features:
- Compile and execute code in 40+ programming languages.
- Switch themes from a list of available themes.

## Installations and setup
## Installation and Setup

1. Clone the repository:

```bash
git clone https://github.com/lohitkolluri/CompileVortex
```

2. Navigate to the project directory:

```bash
cd CompileVortex
```

3. Install dependencies:

```bash
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.

6. Add the API keys to the `.env` file.

7. Run the project:

```bash
npm start
```

- git clone `https://github.com/lohitkolluri/CompileVortex`
- `npm install`
- Register on <a href="https://rapidapi.com/judge0-official/api/judge0-ce/pricing" target="__blank">RapidAPI</a> and get your API keys.
- Create a `.env` file.
- Add the API Keys in the `.env` file
- `npm start` to run the project.
The project will be accessible at `http://localhost:3000`.

0 comments on commit 1bdc5c2

Please sign in to comment.