Skip to content

Latest commit

 

History

History
81 lines (56 loc) · 5.51 KB

README.md

File metadata and controls

81 lines (56 loc) · 5.51 KB
Raw

Content Service

The Content Service primarily focuses on the following core responsibilities:

Content Management

  1. Creating Content:

    • This service enables the creation of content entities. These entities represent an abstraction of actual content, but they do not store actual data such as media files.

  2. Modifying Content:

    • Users can make changes to existing content, updating information or structure as needed.

  3. Deleting Content:

    • Content that is no longer needed can be removed from the system.

Structuring Content

  1. Content Abstraction:

    • Content entities in this service serve as abstractions of actual content, referencing the location of the content in other services. This approach allows for more efficient management of content resources.

  2. Staging Content:

    • Content can be organized into stages, providing a structured approach to content progression.

  3. Ordering Sections:

    • Stages can be ordered within sections, creating a logical flow for content consumption.

User Progress Tracking

  • Tracking User Progress:
    • The Content Service provides mechanisms to track user progress, allowing users to resume where they left off and providing insights into their content journey.

Content Suggestions

  • Suggesting Content:
    • The Content Service offers content suggestions for individual users.
    • Suggestions can be restricted by filter parameters, including chapters, skill types, and the number of suggestions.
    • Suggested content includes required and optional items and is sorted based on various factors.

Environment variables

Relevant for deployment

Name Description Value in Dev Environment Value in Prod Environment
spring.datasource.url PostgreSQL database URL jdbc:postgresql://localhost:4032/content-service jdbc:postgresql://content-service-db-postgresql:5432/content-service
spring.datasource.username Database username root gits
spring.datasource.password Database password root secret
DAPR_HTTP_PORT Dapr HTTP Port 4000 3500
server.port Port on which the application runs 4001 4001

Other properties

Name Description Value in Dev Environment Value in Prod Environment
spring.graphql.graphiql.enabled Enable GraphiQL web interface for GraphQL true true
spring.graphql.graphiql.path Path for GraphiQL when enabled /graphiql /graphiql
spring.profiles.active Active Spring profile dev prod
spring.jpa.properties.hibernate.dialect Hibernate dialect for PostgreSQL org.hibernate.dialect.PostgreSQLDialect org.hibernate.dialect.PostgreSQLDialect
spring.datasource.driver-class-name JDBC driver class org.postgresql.Driver org.postgresql.Driver
spring.sql.init.mode SQL initialization mode always always
spring.jpa.show-sql Show SQL queries in logs true false
spring.sql.init.continue-on-error Continue on SQL init error true true
spring.jpa.hibernate.ddl-auto Hibernate DDL auto strategy create update
hibernate.create_empty_composites.enabled Enable empty composite types in Hibernate true true
DAPR_GRPC_PORT Dapr gRPC Port - 50001

API description

The GraphQL API is described in the api.md file.

The endpoint for the GraphQL API is /graphql. The GraphQL Playground is available at /graphiql.

Get started

A guide how to start development can be found in the wiki.