Skip to content

Latest commit

 

History

History
53 lines (46 loc) · 3.29 KB

README.md

File metadata and controls

53 lines (46 loc) · 3.29 KB
Raw

NexusLink

A collaborative coding web application built with React, Node.js, Express.js, Socket.io, and MongoDB. This platform enables multiple users to collaborate on coding projects in real-time, providing features such as synchronized code editing, group chat, to-do lists, notifications, and more.

Try it here - https://nexuslink01v.netlify.app

Getting Started

  • Clone the repository: git clone https://github.com/Synchrotek/NexusLink.git
  • Navigate to the project directory: cd NexusLink.
  • Install dependencies: npm install ( in the root and server/ directory ).
  • Create .env in root and server/ directories as per the given .env.sample file.
  • Run the Frontend development server: npm run dev
  • In another terminal navigate to the server/ directory: cd server
  • Run the Backend development server there: npm run dev

Tech Stack

Backend Frontend
Node.js React
Express.js Socket.io-client
Socket.io Tailwind
MongoDB daisyUI

Usage

  • Sign up for an account to access NexusLink's features.
  • Explore existing rooms listed on the Home page.
  • Join a room to collaborate with other users in real-time.
  • Create a new room to start a collaborative project.
  • Manage your profile information, including name, bio, and profile picture.
  • Use the Todo App to create, prioritize, and manage tasks within a room.
  • Utilize the Group Messaging feature to communicate with other users in the room.
  • Access the File Explorer to manage and share files within the room.
  • Collaborate on code editing tasks using the Code Editor, with real-time synchronization.
  • Customize the Navbar settings, including programming language and theme selection.
  • Share the room ID with other users to invite them to join the collaboration.
  • Use the Leave button to exit a room and return to the Home page.

Contribution

Explore NexusLink's capabilities and witness how it boosts collaboration. Visit the NexusLink GitHub Repository to access the code and contribute. Community contributions are welcomed to enhance NexusLink, including developers, designers, testers, and documentation enthusiasts.there are many ways you can contribute:

  • Code Contributions: Help to enhance features, fix bugs, and optimize performance by submitting pull requests with your code changes.
  • Documentation: Improve this README, Provide better inline documentation to make it easier for others to understand and use NexusLink.
  • Testing: Help to ensure the quality and reliability of NexusLink by testing new features, reporting bugs, and providing feedback.
  • Feature Requests: Share your ideas and suggestions for new features or improvements that would make NexusLink even more useful for our users.