Skip to content

Latest commit

 

History

History
87 lines (59 loc) · 2.39 KB

README.md

File metadata and controls

87 lines (59 loc) · 2.39 KB

MLH Township

MLH Township Banner

An fun way to interact and have discussions with other fellows on the web. 🎉

November 20th, 2020 - MLH Fellowship Halfway Hackathon Project
by Aayush Joglekar, Gagan Deep, Vishesh Agrawal and Garima Singh.

💁‍♂️ What is the project? | Watch the Demo

MLH Township is a web application that harnesses the power of websockets and webRTC to provide the fellows a playgournd where they can comuunicate and hang out with each other in the game-like setting of MLH Town.

🙇 Why do we need it?

MLH Township makes it extremely easy to be able to cross talk and meet with different fellows throughout the fellowship. It makes it easier than ever to start a conversation or discussion about an event or a topic.

Screenshots!

Landing Page

Screenshot 2

MLH Town

Screenshot 1

Video Chat in rooms

Screenshot 3

💻 Our tech stack!

🧑‍💻 Setting up development environment

The project is divided into two directories client(written in React) and server(written in Node). You will have to spin up individual servers for these components.

Spinning up Node server

  1. Change current working directory to server
cd server
  1. Install dependencies
npm install
  1. Run server
npm start

After following above steps, the backend server should be up and running at http://localhost:5000.

Note: Browsing http://localhost:5000 will render a playing displaying Cannot GET /. You need not get alarmed by this. It is the expected behavior.

Spinning up React server

  1. Change current working directory to client
cd client
  1. Install dependencies
npm install
  1. Run server
npm run

After following above steps, you can browse the client on http://localhost:3000.