UniMeet

UniMeet's aims to simulate the university social experience by allowing communication to occur on a virtual campus.
.

View Demo . Report Bug . Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

UniMeet is an online communication platform where users can voice chat with one another in different rooms within different buidlings at UCT.

(back to top)

Built With

• React.js
• Material UI
• Express
• simple-peer
• Socket.IO

(back to top)

Getting Started

UniMeet is a simple web app and can be run fairly simply.

Prerequisites

Use npm to install all the prerequisite libraries:

• npm

  npm install
  npm start

then cd into the frontend folder and perform the npm install again and start the front end. separate terminals need to be used.

Usage

Navigate to: http://localhost:3000 with your browser.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Jaron Cohen, Edan Toledo, Roy Cohen

• jdicohen -at- gmail.com
• edan.toledo -at- live.com
• rtcohen99 -at- gmail.com

(back to top)