Skip to content

Latest commit

 

History

History
45 lines (30 loc) · 1.37 KB

INSTALLATION.MD

File metadata and controls

45 lines (30 loc) · 1.37 KB

Steps for setting up the project locally

  1. Clone the caucus Repository
git clone https://github.com/Rishabh-malhotraa/caucus.git
  1. Create a new file .env and copy contents of .env.example file to the .env file
touch .env
  1. Clone the caucus-server from github
git clone https://github.com/Rishabh-malhotraa/caucus-server.git
  1. Create the .env file as mentioned in the readme file

If you want the oauth to work locally you need to get your own client key and client secret from the oauth provider(check the readme file), you can also skip this step if you dont want to enable oauth and just login to room using login as guest feature

  1. Start the react front end by moving opening bash in the client folder and running the following commmand
npm run start

Run the CRDT SERVER inside the caucus repository run the following bash command

npx y-websocket-server
  1. Start the nodejs backend using by running the following code in the server folder6
npm run dev
  1. I recommend opening a workspace on your favorite editor with the server and client folder openend.

If you have any difficulty in setting up the project locally let me know by opening an issue on github, or contacting me on discord.