mjh316 / tsa-submissions-coding-api

This repo is the API for the TSA Submissions Coding solution. It's used to expose functionality to the UI.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

TSA Submissions Coding API

This project is part of a larger solution built for the Technology Student Association (TSA) High School Coding competition. This API project is designed to be the heart of the solution to automate the testing and evaluation of solutions to coding problems presented to the students.

Status Badges

Badge Description
cicd-main-badge main Branch ci-cd-workflow Run
codeql-badge Latest CodeQL Run
codecove-badge Codecov
sc-qg-badge SonarCloud Quality Gate - C#
sc-m-badge SonarCloud Mantainablity Grade
sc-r-badge SonarCloud Reliablity Grade
sc-s-badge SonarCloud Security Grade
sc-loc-badge Lines of Code

codecov-graph

Project Description

This API project exposes core functionality to both the UI and to tools/utilities that test and evaluate submissions by students. It is a .NET 7.0 based project designed to run various environments such as Docker, IIS, Kubernetes, and/or Linux. The project also uses MongoDB for document/database storage and RabbitMQ to send messages for submissions that need to be evaluated.

Features

TODO: Fill in as features are implemented

Getting Started

To get up and running with this project, there is a Getting Started guide in the /docs folder of the repo. Read this to learn how to quickly get up and running with the application as there are some intricacies to it.

Contributing

We welcome anyone that would like to volunteer their time and contribute to this project. In order to contibute, we do require you to adhere to our Code of Conduct. Please take a moment to read over this as it is strictly enforced.

Once you agree to our Code of Conduct, take a look at our Contributing Guidelines. This will help explain our coding style, testing practices, and process for integrating your changes into our repo and master branch.

How to Start Contributing

TODO: Define a way for external contributions

Related Projects

About

This repo is the API for the TSA Submissions Coding solution. It's used to expose functionality to the UI.

License:MIT License


Languages

Language:C# 97.0%Language:PowerShell 1.6%Language:JavaScript 1.1%Language:Dockerfile 0.2%