Skip to content

Latest commit

 

History

History
59 lines (30 loc) · 2.6 KB

README.md

File metadata and controls

59 lines (30 loc) · 2.6 KB
Raw

YTParty

Watch youtube in sync with your friends!

Visit our website at [REDACTED] to see this project in action. (This site is no longer active and domain is no longer in our ownership)

Watch our demo at https://www.youtube.com/watch?v=Y8Tq7FqnPMc

Check our uptime at [REDTACTED] (This site is no longer active and domain is no longer in our ownership)

Development

  1. Copy the contents from .env.development.example to .env for both the frontend/ and backend/ folders

    cp ./frontend/.env.development.example ./frontend/.env && cp ./backend/.env.development.example ./backend/.env

  2. Run docker-compose for the docker-compose.dev.yml file

    docker-compose -f docker-compose.dev.yml up -d

  3. Start up your apps as you normally do by running npm run start in both the frontend/ and backend/ folders

Deploying

Note: this can be used for development as well if you skip the steps labelled (Prod)

  1. Copy the contents from .env.development.example to .env for both the frontend/ and backend/ folders

    cp ./frontend/.env.docker.example ./frontend/.env && cp ./backend/.env.docker.example ./backend/.env

  2. (Prod) Change the password for mongo in both docker-compose.yml as well as ./backend/.env

  3. (Prod) Change the SESSION_SECRET in ./backend/.env to something random and complex

  4. (Prod) Change the FRONTEND_ORIGIN and ROOT_DOMAIN to match your domain that your frontend is hosted on in ./backend/.env.

    Ex: an app hosted at [REDACTED] would have FRONTEND_ORIGIN=[REDACTED] and ROOT_DOMAIN=[REDACTED] (This site is no longer active and domain is no longer in our ownership)

  5. (Prod) Change NODE_ENV to production in ./backend/.env.

  6. (Prod) Change REACT_APP_BACKEND_URI to point to your backend api

    Ex: an api you want hosted at [REDACTED] would have REACT_APP_BACKEND_URI=[REDACTED] (This site is no longer active and domain is no longer in our ownership)

  7. Run docker-compose

    docker-compose build && docker-compose up -d

The frontend should be listening on port 3000 and the backend on 5000. Just stick your favourite reverse proxy in front of it!

Note: the docker containers binds to 127.0.0.1:PORT:PORT which means that it only binds to docker's network interface. If you aren't using a reverse proxy and want to expose this to the public, you'll need to modify the docker-compose file to bind directly to PORT:PORT instead

API Documentation

Please see DOCS.md

Credits

You can visit [REDACTED] to view all the code snippets, tutorials, and documentation we referenced. (This site is no longer active and domain is no longer in our ownership)