Skip to content
This repository has been archived by the owner on Sep 19, 2021. It is now read-only.

Latest commit

 

History

History
78 lines (54 loc) · 2.35 KB

README.md

File metadata and controls

78 lines (54 loc) · 2.35 KB

Sync Build Status Coverage Status Known Vulnerabilities Maintainability

View Demo

Table of Contents

What is Sync?

Sync is a web application where you can watch videos from other websites with others in a chatroom! Our chatroom comes loaded with emotes from BTTV while also providing entertainment with a chatbot!

Main Dependencies

  • Express.js
  • React.js
  • Typescript
  • Socket.io

Installation

git clone https://github.com/yeno-team/sync.git

# Install Server Dependencies
cd sync
yarn install

# Install Client Dependencies
cd src/client
yarn install

Configuration

Server Environment Variables

File should be at root named .env.[environment here] ex. .env.development, .env.production

A Proxy is Required because it is used to scrape from sites.

Name Description
PORT Main Server's Port (default: 8080)
PROXY_HOST HTTP proxy host (required)
PROXY_PORT HTTP proxy port (required)
PROXY_USERNAME HTTP proxy auth username (optional)
PROXY_PASSWORD HTTP proxy auth password (optional)
REDIS_HOST Redis Instance hostname (required)
REDIS_PORT Redis Instance Port (required)
REDIS_PASSWORD Redis Instance Password (required)

Client

There is a config folder with the configurations.

Deployment

A .env.production file is required

# IN ROOT DIRECTORY
yarn build
yarn deploy

Contributing

All contributions are welcome! Just send a pull request our way. If the change is big, please start a issue first before working on it.

License

MIT