Skip to content

A collab app for students,teachers and colleagues to interact, share and collaborate ideas in a simplified manner.

License

Notifications You must be signed in to change notification settings

tarunluthra123/Kollab-Space

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Kollab Space

License: MIT npm total-lines node

A collaborative work environment for teams and friends to work together with increased productivity in sophisticated environment.

The project has been deployed on render.com and can be viewed here.

About the project

Users can signup, login, join chat rooms and live chat with their friends.
Users can also edit code in the code editor which allows multiple language support with autocompletion feature and all changes are reflected to all other users in the chat room synchronously.

Tools and Technologies used

  • React
  • Typescript
  • ExpressJS
  • Socket.io
  • Sequelize with PostgreSQL
  • Semantic UI CSS
  • JSON Web Tokens

Demo Video

DEMO VIDEO

Screenshots

alt-text alt-text alt-text

Setting up the project

  1. Clone this repository
git clone https://github.com/tarunluthra123/Kollab-Space.git
  1. Install dependencies

Open the folder and install all the dependencies

yarn install
  1. Setting up the database

Run the following commands in your postgres shell.

create database kollab;
CREATE USER kollabadmin WITH ENCRYPTED PASSWORD 'kollabpass';
GRANT ALL PRIVILEGES ON DATABASE kollab TO kollabadmin;

You may opt other database name, username and password. However if you do so, make a .env file and store that information in the .env file.

The .env file is not required if you opt for default settings.

Alternatively, if you choose other database credentials but do not intend to create a .env file, you can make the changes in /backend/db/connection.js .

  1. Running the project locally

Once set up open the project directory and open two terminals.
In the first terminal, run the backend server.

yarn server

This should run your backend server on localhost:7483. To choose any other port, change the port number in backend/server.js.

In the second terminal, run the frontend development server.

yarn react

This will run your frontend on localhost:3000.

Your project is up and running. Enjoy !!

About

A collab app for students,teachers and colleagues to interact, share and collaborate ideas in a simplified manner.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published