Collaborator

A collaborative workspace manager built using NextJS, ShadCn UI powered by Supabase Backend that supports realtime document editing using WebSockets.

There's no demo, sorry 😔

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. License
4. Contact

About The Project

demo.mp4

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Get API Keys/ URIs for your Supabase Project. You need to set these up manually.
2. Clone the repo

   git clone  https://github.com/asish918/Collaborator.git

3. Install NPM packages

   npm install

4. Enter your API keys in .env. Refer the .env.example file
5. Use the database.sql file and run it entirely as a query in SQL Editor of Supabase. That would create all the schemas and buckets required for the web app.
6. Run the project

   npm run dev

   (back to top)

Database Schema

Refer to this visual schema to understand better

(back to top)

License

Distributed under the MIT License. See LICENSE for more information. Basically you can do whatever the hell you want to with the code 😉

(back to top)

Contact

Asish Mahapatra - [email protected]

The project has not been deployed because it uses WebSockets and that requires you to operate a server with paid plans which I don't intend to do just so that random people can viewe my project. So go ahead, clone it, configure it and make it yours

Project Link: https://github.com/asish918/Collaborator

(back to top)