Skip to content
This repository was archived by the owner on Jan 17, 2025. It is now read-only.

LetsStreamIt/profile-service

Repository files navigation

Profile Service

CI status

License: MIT Version

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

Profile service is responsible for managing the user profile information in the LetsStreamIt platform. It manages the user's username, bio, and watched videos.

Technologies

Scala Akka

Infrastructure

Docker

DevOps

GitHub Actions Semantic Release Semantic Versioning Conventional Commits Renovate SonarCloud

Getting Started

Prerequisites

In order to run the project, you need to have the following tools installed on your machine:

Installation

To install the project, you need to clone the repository:

git clone https://github.com/LetsStreamIt/profile-service.git
cd profile-service

Usage

  1. You can either run the application using the sbt command:

    sbt run
  2. Or you can build the Docker image:

    sbt docker:publishLocal

    And run it using Docker:

    docker run -p 8080:8080 ghcr.io/letsstreamit/profile-service:latest
  3. Or using docker-compose in a similar way to the one found at the LetsStreamIt/bootstrap repository.

Configuration

If you want to configure the application, you may set the following environment variables:

Variable Description Default
PROFILE_SERVICE_HOSTNAME The hostname of the profile service localhost
PROFILE_SERVICE_PORT The port of the profile service 8080
MONGO_HOSTNAME The hostname of the MongoDB server localhost
MONGO_PORT The port of the MongoDB server 27017
AUTH_SERVICE_HOSTNAME The hostname of the auth service localhost
AUTH_SERVICE_PORT The port of the auth service 3000
AKKA_LICENSE_KEY The license key for Akka, you can get it at https://akka.io/key ""

Documentation

The documentation and API reference can be found at the API documentation.

Contributing

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

License

This project is licensed under the MIT License - see the LICENSE file for details.

Authors

About

Profile service for the LetsStreamIt platform

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors 4

  •  
  •  
  •  
  •