ASP - GATAM ISW-IP

This project aims to make a web app for the GATAM company.

The goal of this website is to create a quiz-like platform for the users of GATAM to answer questionaires.
These questionaires can then be followed, made and linked to users by the mentors.

This project is built using:

• Backend: ASP.NET
• Frontend: Blazor
  • CSS Framework: Blazor Bootstrap
• Database: MSSQL Server

Table of contents

• Installation
  • Prerequisites
  • Run the project using Docker
• Environment variables
  • URL Configuration
  • Auth0 configuration
• Documentation

Installation

Prerequisites

• Docker
• Traefik

Run the project using Docker

1. Refer to the environment variables section for setting up the environment variables.

2. Make sure you have Traefik running.

This project does not provide an already set up instance.
For more information see here: https://hub.docker.com/_/traefik
By default the docker configuration will need a "Traefik" network, you can add a new network by running docker network create Traefik.

3. Use a terminal to go inside ./docker and execute the docker compose up command to run the project.

Environment variables

• MSSQLSRV_DB_URL: The datasource URL used for connecting to the database.
• MSSQLSRV_PASSWORD: The password used by the database.
• JwtIssuerSigningKey: The signing key used for signing JWT tokens.
• DefaultAdministratorEmail: The default name for the administrator email.
  Example: "administrator"
• DefaultEmail: The default email prefix used to create accounts with. This is also used as the email prefix for the administrator account.

URL Configuration

• PATH_PREFIX: The path prefix for the API, hosted on PROJECT_HOST
• PROJECT_HOST: The domain where the website for the admin-like GATAM users is hosted on.
  Example: domain.com
• PROJECT_USERS_HOST: The domain where the website for the GATAM users is hosted.
  Example: domain-users.com

Auth0 configuration

This project by default uses Auth0, to create an Auth0 API, refer to this tutorial: https://auth0.com/docs/quickstart/webapp/aspnet-core-blazor-server/interactive

• Auth0Domain: The Auth0 API (or URL) for your account.
• Auth0Audience: The Auth0 token for access to the API.
• Auth0ClientId: The identifier for the Auth0 client.
• Auth0ClientSecret: The secret token for the Auth0 client.

Documentation

For more information see the user manual, technical documentation and the ERD.

AppliedSoftwareProject