antoine13/opentogethertube repository overview

⁠OpenTogetherTube

The easy way to watch videos with your friends.

http://opentogethertube.com/⁠

⁠Contributing

Contributions are welcome. The current iteration is named "Firework", and you can see what's currently being worked on under the "projects" tab.

⁠Setting up your dev environment

⁠Prerequisites

This project targets the lastest LTS version of node.js.

⁠Setup

1. Fork this repo and clone it.

   If you are planning to deploy this yourself, make sure you are on the master branch.

2. In a terminal, navigate to the opentogethertube folder and run

npm install

1. Next you need to set up your configuration. Start by copying the example config in the env folder to a new file called development.env

cp env/example.env env/development.env

1. Obtain a YouTube API key
2. Open env/development.env and replace API_KEY_GOES_HERE with the youtube api key.
3. Initialize your local database.

npx sequelize-cli db:migrate

1. Install redis⁠. This is used to store room state and user sessions across server restarts.

⁠Testing

To run the test suite, run

npm test

⁠How to run

This project has 2 main components: the client and the server. You can run both of them simultaneously using the command

⁠Linux / Mac

npm run dev

⁠Windows

npm run dev-windows

Sometimes, you may want to run them seperately so you can use breakpoints to debug. Using VSCode, this is trivial.

To start the server: Debug > Select "Launch Program" > Start

To start the client: npm run serve

⁠Deployment

1. Clone this repo.
2. Install despendencies.

npm install

1. Build Vue files so they can be served statically.

npm run build

1. Run the server.

npm start

You can also specify the port the server will listen on by setting the PORT environment variable.

PORT=8080 npm start

⁠Docker

Go to Docker⁠