/collabnex

An Online Real Time Collaborative code Editor

Primary LanguageTypeScript

Great! Here's a README file for your GitHub repository, CollabNEX:

# CollabNEX

CollabNEX is a collaborative platform that facilitates seamless communication and project management among team members. It integrates various tools and services to enhance productivity and collaboration.

## Features

- Real-time messaging
- Project management tools
- File sharing and storage
- Task assignment and tracking
- Calendar integration
- User authentication and roles

## Installation

To get a local copy up and running, follow these steps:

### Prerequisites

- Node.js
- npm

### Clone the Repository

```bash
git clone https://github.com/MIKHAEI/CollabNEX.git
cd CollabNEX

Install Dependencies

Navigate to the client and server folders and install the dependencies:

cd client
npm install

cd ../server
npm install

Run the Application

Run the following command in both the client and server folders to start the application:

npm run dev

The client will be running on http://localhost:3000 and the server on http://localhost:5000.

Usage

  1. Open your browser and navigate to http://localhost:3000.
  2. Register a new account or log in with an existing account.
  3. Start creating projects, assigning tasks, and collaborating with your team.

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Harsha Dodamani
harshavardana4242@gmail.com

Project Link: https://github.com/MIKHAEI/CollabNEX