Quiz app

Description

ASP.NET based quiz app, which helps students and teachers to conduct quizes and make learning easier.

Tech stack

Development setup

This repo contains two projects: the web api written using ASP.NET (QuizAppApi) and react frontend using Vite (better-frontend). You first need to run web api and, after that, run the frontend.

DB & OpenAI API setup

We use mssql server dbms. Make sure to install it, a viable option is to use Docker image. No matter how you setup your dbms, you need to get the connection string, it may look like this:

Server=127.0.0.1,1433; Database=Master; User Id=SA; Password=REALLY_SECURE_PASSWORD; Encrypt=False; TrustServerCertificate=True;

This video may help when setting up the db.

Connection string and API key are added via secrets:

cd QuizAppApi/QuizAppApi
dotnet user-secrets set "ConnectionString" "YOUR_CONNECTION_STRING"
dotnet user-secrets set "OpenAiAPIKey" "YOUR_API_KEY"
dotnet user-secrets set "JWT_SECRET" "random long string"

Make sure to apply migrations (You can google on how to do that)

Backend setup

If you are using an ide, setup should be straightforward. You can also run it via cli:

dotnet run # or
dotnet watch

Backend tests

To run .NET tests use this command in QuizAppApi.sln directory:

dotnet test

Frontend setup

cd better-frontend/
npm install
npm run dev

Table of contents

• Quiz app
  • Description
  • Tech stack
  • Development setup
    • DB setup
    • Backend setup
    • Backend tests
    • Frontend setup
  • Table of contents
  • Branching strategy
    • Branches
  • Naming
    • Branch naming
      • Example
    • Commit naming
      • Example
  • Repository rules
  • Authors

Branching strategy

Branches

• Main branch - used as a branch for all feature branches to merge and in this environment the app is tested.
• Feat branch - these branches are branched from main branch and are used for developing.
  • Each feature branch is used for a different task and each feature branch belongs to it's owner and should be worked on by the owner.

Naming

Branch naming

• Branch names should begin with feat
• Feat branch name should give information about the task
• Words in branch name are seperated by dashes (-)
• If the feat branch is a branch of another feat branch, the name should have a number at the end

Example

• "feat-pipeline"
• "feat-pipeline-2"

Commit naming

Commit messages should begin with one of the following:

• Add
• Delete
• Change
• Fix

Example

• "Add ASP.NET template"
• "Change README.md"
• "Delete build files"

Repository rules

• Approver count
  • Main: 1

Authors

• Aldas Vertelis
• Danielius Podbielski
• Kanstantinas Piatrashka
• Motiejus Šveikauskas