letsstreamit-frontend-service

Frontend Service

CI status

License: MIT Version

Code Smells Vulnerabilities Duplicated Lines (%) Quality Gate Status Technical Debt Security Rating

Frontend Service is responsible to manage the frontend of the Web application.

Through the website the user can:

  • Authenticate to the system, by registering and login to it thanks to the auth-service;
  • Create and/or join a Youtube streaming session and interact with the corresponding video and chat, by using session-service;
  • Navigate to the profile page and get public user information, thanks to the profile-service;

Node.js Socket.IO

Docker

GitHub Actions Semantic Release Semantic Versioning Conventional Commits Renovate SonarCloud

Typedoc

In order to run it, specify the following environment variables:

Variable Description
SESSION_SERVICE_HOSTNAME The hostname of the session service
SESSION_SERVICE_PORT The port of the session service
PROFILE_SERVICE_HOSTNAME The hostname of the profile service
PROFILE_SERVICE_PORT The port of the profile service
AUTH_SERVICE_HOSTNAME The hostname of the auth service
AUTH_SERVICE_PORT The port of the auth service
AKKA_LICENSE_KEY The license key for Akka

The frontend service can be deployed through a Docker container:

  1. Create a env.list file specifying the environment variable values, as example:

    PROFILE_SERVICE_HOSTNAME="localhost"
    PROFILE_SERVICE_PORT=3001
    AUTH_SERVICE_HOSTNAME="localhost"
    AUTH_SERVICE_PORT=3000
    SESSION_SERVICE_HOSTNAME="localhost"
    SESSION_SERVICE_PORT=4000
    
  2. Run the docker container, by substituting LOCAL_PORT with your preferred port:

    docker run --env-file -p LOCAL_PORT:80 ./env.list ghcr.io/letsstreamit/frontend-service:main
    

    If the other services are running in localhost, add the option --network host to let the service contact them.

If you want to contribute to the project, please read the CONTRIBUTING.md file.

Frontend Service is licensed under the MIT License - see the LICENSE file for details.