This is an experimental project

Meetup online

A simple online meeting app runs on browser. Implemented in TypeScript with WebRTC, Nodejs and React.

View Demo »

About The Project

Due to the influence of COVID-19, the social value of online communication tools is increasing more than ever. Therefore, we will contribute to society by creating an online communication tool that is (1) open source, and (2) simple and highly extensible.

Built With

Some major frameworks that we used to built our project.

• WebRTC
• React
• TypeScript
• Nodejs

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• npm

  npm install npm@latest -g

Obtaining TURN/STUN credentials using Xiysys

Follow the steps as in webtutsplus.

1. Do not use the credentials provided
2. Go to https://xirsys.com/
3. Sign Up
4. Log in to your account
5. Click on + beside MyFirstApp
6. Click on static TURN Credentials Button located below Account Type.
7. Accept the warning by click on + that appears just after you clicked on static TURN Credentials.
8. Copy the text(begins with iceservers) that appears below static TURN Credentials and paste in config.js as shown in config.js.

Installation

1. Get a free API Key at https://xirsys.com/ as above.
2. Clone the repo

   git clone https://github.com/sano-jin/meetup-town.git

3. Install NPM packages

   npm install

4. Enter your API in config.ts

   export const turnConfig = 'ENTER YOUR API';

5. Build

   npm run build

Directory structure overview after build

+- public/                     % code/resources to distributes to clients
|   +- css/styles.css
|   +- assets/meetup_icon.svg
|   +- dist/bundle.js          % generated with `npm run build`
+- src/
|   +- server/                 % server side code
|   +- client/                 % client side code
|   +- ...
+- dist/server.js              % generated with `npm run build` 
+- view/index.ejs
+ ...

Usage

1. Start running locally

   npm run start

2. Open localhost:8000 on your browser

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

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

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

License

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

Contact

sano - @sano65747676

Project Link: https://github.com/sano-jin

Acknowledgements

• webtutsplus