/Noodle-Classroom-API

A web API that provides course, student and assignment data to the Noodle Classroom App

Primary LanguageC#

Noodle Classroom API

Work in progress. (No releases yet)

On this file

About the Project

The Noodle Classroom App is intended to be a very simplified mimic of Google Classroom, allowing both professors and students to create, join and follow courses through groups. Each course has a collection of publications and a collection of participants. This repository contains the web API, which serves the resources to the application client through REST endpoints.

The main features of this project are:

  • Join or create classes.
  • View course publications, assignments and announcements.
  • Receive feedback for each assignment turned in.

Repo Structure

This project contains two main directories: NoodleApi/, which contains the files for the web API and Tests/, the directory for the api unit tests.

noodle_classroom_api/
├── README.md
├── .gitignore
├── noodle_classroom_api.sln
└── NoodleApi/
	├── NoodleApi.csproj
	├── appsettings.json
	├── appsettings.Development.json
	├── Program.cs
	├── Startup.cs
	└── Controllers/
		└── CourseController.cs
	└── Data/
		├── CourseContext.cs
		├── CourseRepository.cs
		└── ICourseService.cs
	└── Docs/
		├── controller_docs.xml
		├── data_docs.xml
		└── model_docs.xml
	└── Models/
		├── Course.cs
		├── CourseDTO.cs
		├── CourseSimplifiedDTO.cs
		├── Extensions.cs
		├── Publication.cs
		└── PublicationDTO.cs
	└── Properties/
		└── launchSettings.json
└── Tests/
	├── Tests.csproj
	├── Utils.cs
	├── CourseControllerTests.cs
	└── docs/
		├── tests_doc.xml
		└── tests_util_doc.xml

Software requirements

  • .NET SDK (5.0.303)
  • Git

API Dependencies

Test Dependencies

Other information

This project is still work in progress.