README.md

CompileX

CompileX is a realtime collaborative code editor/compiler which helps users to connect, share, code & debug together in a seamless and engaging way.

Table of Contents

• Technologies Used
• Features
• Getting Started
  • Pre-requisites
  • Installation
• How to Contribute?

Technologies Used

• Frontend:

  • React
  • Javascript
  • Tailwind CSS

• Backend:

  • Node.js
  • Express.js
  • Socket.io

• Editor & Code Compilation:

  • CodeMirror
  • judgeO

Features

• Responsive Design: A responsive and mobile & web friendly UI to provide a consistent experience across devices.

• Realtime Collaboration: Users can collaborate in real-time, making it easy to work together.

• Code Compilation: Compile your code with judgeO and get the result in realtime.

• Code Sharing: Share your code with your friends and collaborate on the same code.

• Code Editor: Using CodeMirror to write your code and get the syntax highlighting and debugging features.

• Stylish UI with Tailwind CSS: Utilizing the power of Tailwind CSS to create a visually appealing and customizable user interface.

Getting Started

Prerequisites

• Node.js and npm installed on your machine.

Installation

With Docker

1. Clone the repository:

   git clone https://github.com/Ratangulati/CompileX

2. Navigate to the project directory:

   cd CompileX

3. Run Docker Compose:

   docker-compose up

   The app should now be running at http://localhost:3000.

Without Docker

1. Clone the repository:

   git clone https://github.com/Ratangulati/CompileX

2. Navigate to the project directory:

   cd CompileX

3. Install dependencies:

   npm install

4. Start the development server:

   npm start

   The app should now be running at http://localhost:3000.

5. Example .env You can use in your localhost

VITE_BACKEND_URL=http://localhost:3000

How to Contribute

To know how to contribute to the project visit CONTRIBUTING.md.