Skip to content

Latest commit

 

History

History
64 lines (40 loc) · 2.42 KB

Readme.md

File metadata and controls

64 lines (40 loc) · 2.42 KB

Introduction

Build Status
GitHub commit activity GitHub repo size GitHub top language

Swagger API

Retroactiune is a project for managing Feedback. It works in the following way, an Admin to creates FeedbackReceivers that will receive Feedback. Then it will generate Tokens that can be distributed to the users. A Tokens is bound to a single FeedbackReceiver and it's a one time use for giving Feedback.

The given Feedback is anonymous by design.

Tech Stack

The project uses ASP .Net Core 3.1 and MongoDB.

dotnet --version
3.1.407

Architecture

Example deployment architecture which uses Prometheus & Grafana for monitoring, Auth0 as a authorization server and Sentry for error reporting.

Example deployment architecture

The application code is organized using the Clean Architecture approach.

Example deployment architecture

Authorization Provider

An external Authorization provider is required in order to run the API, the provider needs to support Bearer tokens and HS256 key signing algorithm. RS256 is currently not supported.

I recommend that you start with Auth0 and their free tier.

See the following resources:

Developing

To install the dependencies run dotnet restore.

To run the project run

dotnet run --project .\Retroactiune.WebAPI\

To run unit and integration tests run:

Note: Docker and Docker-Compose are needed to bring up the dependent services, see docker-compose.yaml.

docker-compose up -d
dotnet test

The projects has ~96% code coverage.