OwnSpace

OwnSpace is an awesome Document Collaboration Platform. OwnSpace provides real-time character by character updtation to users working on the same document. User can Sign Up or Login using Auth0 authentication and can start creating document. Each document is initiated with particular unique id.

📔 Table of Contents

About the Project
Getting Started
Contact

🌟 About the Project

📷 Screenshots

👾 Tech Stack

Client

Server

Database

MongoDB

🎯 Features

Real-Time Character Updation
Authentication with Auth0
No Page Reload

🎨 Color Reference

🔑 Environment Variables

To run this project, you will need to add the following environment variables to your .env file

REACT_APP_AUTH0_DOMAIN

REACT_APP_AUTH0_CLIENT_ID

MONGODB_URI

NODE_ENV

🧰 Getting Started

‼️ Prerequisites

This project uses NPM as package manager

 npm install

⚙️ Installation

Install OwnSpace with npm

  npm install my-project
  cd OwnSpace

🏃 Run Locally

Clone the project

  git clone https://github.com/ItsAmanOP/OwnSpace.git

Go to the project directory

  cd OwnSpace

Go to the client directory

  cd client

Install dependencies

  npm install

Start the client at localhost:3000

  npm start

Go to the server directory

  cd server

Install dependencies

  npm install

Start the server

  npm start

🚩 Deployment

To deploy this project put client inside server and run

  npm deploy

🤝 Contact

Aman Karpentar - @AGFlexHD - aman.karpentarcs2018@indoreinstitute.com

Project Link: https://github.com/ItsAmanOP/OwnSpace

ItsAmanOP/OwnSpace