An open API service indexing awesome lists of open source software.

https://github.com/anchovycation/pingu-front-end

The best way to watch YouTube by video chatting with friends.
https://github.com/anchovycation/pingu-front-end

chat react reactjs socket-io video-chat webrtc youtube

Last synced: 2 months ago
JSON representation

The best way to watch YouTube by video chatting with friends.

Awesome Lists containing this project

README

          





Pingu

The best way to watch YouTube by video chatting with friends.

> It is **not suitable** for **use** as it is still in the **pre-development** stage.

## Introduce
+ [Roadmap](#roadmap)
+ [Technologies planned to be used](#technologies-planned-to-be-used)
+ [Usage](#usage)
+ [Contributing](#contributing)
+ [Contributors](#contributors)
+ [License](#license)

## Roadmap
You can see what we've done before and what we will work on in the future.

**pre-development**:
- [x] Basic chat
- [X] Basic user interface
- [X] Multiple room support
- [ ] Embeded YouTube

**development**
- [ ] Voice and Video chat
- [ ] New user interface
- [ ] Basic test
- [ ] Dockerize, CI/CD, GitHub Bots, pre-production

**production**
- [ ] Theatre and fullscreen mode
- [ ] Mobile user friendly interface
- [ ] PWA

### Technologies planned to be used
TypeScript(optional), Socket.io, React, Next.js

## Usage
## Install
```bash
git clone https://github.com/anchovycation/pingu-front-end
cd pingu-front-end
```

## Setup
Install dependencies
```bash
npm install
```

## Set Environment Variables
```bash
cp sample.env .env
```

## Start
```bash
npm start
```

## Contributing
If you want to contribute to the project, please first **check** if the work you are doing is already an **issue**. If there is an issue and there is someone assigned to the issue, **contact that person**. If there is no issue, you can send your development to the project managers by opening a **pull request**. Please read [CONTRIBUTING.md](./CONTRIBUTING.md)

## Contributors


## License
[GNU GENERAL PUBLIC LICENSE Version 3](./LICENSE)