Skip to content

Hackathon project implementing WebRTC for live chatting

Notifications You must be signed in to change notification settings

mhwilkes/Cheers-Mate

Repository files navigation

Cheers Mate!

demo

Live example hosted on heroku can be found at cheersm8.tk

Talking to your friends couldn't be simpler!

It is built using the React, Express, simple-peer, and BulmaCSS.

Features

Essentially, here're some of its features:

  • 4 Person private meeting rooms
  • Silent Disconnects
  • Clean mono-repo structure with Express Server and React Client
  • Copy and Paste meeting rooms
  • WebSockets used for peering
  • Pretty UI using Bulma and Styled Components
  • Easy deployability on Heroku

Setting Up

Recommended Tools Checklist

Installing Requirements

$ git clone https://github.com/mhwilkes/Cheers-Mate.git
$ cd Cheers-Mate
$ yarn setup
Configuring Enviromental Variable

Create a ".env" in "src/client", it should look like the following:

REACT_APP_API_URL="http://localhost:5000"

Running Project

$ # run both server and client
$ yarn dev
$ # run server only
$ yarn server
$ # run client only
$ yarn client

To Deploy

Deploying this project on Heroku is dead simple. Basically, go on Heroku and create a new Heroku app, connect your project Github to your new Heroku app, and hit Deploy. Note, that you will need to configure the environmental variable under settings.

About

Hackathon project implementing WebRTC for live chatting

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published