Fake Survey Generator

This is an app. That generates surveys. Fake ones. For fun. That is all.

Component(s) Build Status
Fake Survey Generator API Build Status
Fake Survey Generator UI Build Status
Azure Infrastructure Build Status

Screenshot

Screenshot

What is this?

This is a .NET | C# | React | TypeScript full-stack application of moderate complexity (not just a to-do app), used as a playground for experimentation. Simply put: This is where I mess around with code. It is heavily inspired by the .NET Microservices: Architecture for Containerized .NET Applications book, as well as its companion reference application eShopOnContainers. It also incorporates various elements from different repos & blog posts which served as inspiration.

It is built using Clean Architecture principles with CQRS (Command Query Responsibility Segregation) and DDD (Domain-Driven Design) thrown into the mix. It doesn't follow these principles to the letter, but provides a decent example of how to apply the basics of these principles.

It is heavily centered around the Microsoft .NET + Azure technology stacks as these are what I have the most experience in & just like building things with. 😀

Here are some of the features incorporated into this project:

Application Features

Infrastructure Features

Some of the above features are relatively straightforward to implement, others have some intricacies that require some Googling in order to set up. I just like to have them placed in the context of a complete working application to refer back to when necessary.

Why is this here?

I wanted something to try new things out on, without the risk of substantially endangering an actual production environment used by actual people.

It was for this reason that I built the Fake Survey Generator (FSG) app as a way to test out tools, libraries, patterns, frameworks & various other stuff.

It has a very simple domain: it generates surveys. Fake ones. They can be used as a tool for helping you decide what to have for dinner, which book you should read next, where you should go for your next team lunch, or anything that tickles your fancy.

This application is also used as a reference for configuring/wiring up some common things I sometimes forget how to do. Living Documentation if you will. You know the culprits: How do I wire up that database again? What is the syntax for that logging configuration? How do I make thing A talk to thing B?

The domain is kept relatively simple such that it doesn't overwhelm the app with unnecessary complexity. It should be quite easy to wrap your head around without requiring a degree in Computer Science.

I also felt that a lot of reference/demo/boilerplate projects out there cover the core application domain & don't go into much detail around the building/deployment/hosting of final application. So this project aims to cover both. It contains application code, configuration, CI/CD pipelines, infrastructure-as-code needed to run the application, as well as a live, running version of the application (as long as budget allows 😁). So this repo hopefully may contain something for everyone & fill in the potential gaps across the whole spectrum of application development. It falls somewhere between a template/boilerplate project & a real-world production open-source application.

How is this thing structured?

FSG consists of two parts:

Server

The server side consists of the following main components:

  • Fake Survey Generator API
    • Domain Project
    • Domain Unit Tests Project
    • Infrastructure Project
    • Application Project
    • Application Tests Project
    • API Integration Tests Project
    • EF Design Project (used purely for EF Core design-time tooling)
    • Data Project (helpers for test data used across test projects)
  • Fake Survey Generator Worker

The server side makes use of the following tools, libraries & frameworks:

Client

The client side consists of the following main components:

  • UI

The client side makes use of the following tools, libraries & frameworks:

Common

The application is built for Docker, Docker Compose & Kubernetes with Helm. For local development, Docker Compose is used when debugging the application with Visual Studio, and Skaffold is used to package the application into a Helm chart to deploy to a local Kubernetes cluster for running locally.

The hosted version of the application is deployed here: https://aks.fakesurveygenerator.mysecondarydomain.com

The following endpoints are accessible:

  • /swagger - The Swagger documentation page for the API
  • /health/live - Health Checks endpoint used by Kubernetes liveness probe
  • /health/ready - Health Checks endpoint used by Kubernetes readiness probe

The hosted version utilizes the following infrastructure:

Authentication

The application makes use of OpenID Connect for authentication which is implemented by Auth0. Currently supported connections are:

  • Auth0
  • Google
  • Microsoft

Initially, this project used IdentityServer for authentication, but I didn't feel like maintaining the separate IdentityServer project as well as the Fake Survey Generator, so I switched it out for Auth0 because authn/authz is hard and I prefer to delegate that responsibility to the people who know how to do it properly. 😁

How do I run this thing?

In order to run FSG on your local machine, you will need the following prerequisites:

To run with Docker Compose:

  1. After installing mkcert, run: mkcert localhost in the certs directory to create the localhost development certificates. If successful, the following will be printed:

    The certificate is at "./localhost.pem" and the key at "./localhost-key.pem"

  2. In a Terminal/Command Prompt/PowerShell window in the project root, run:

    docker-compose up

  3. In a browser, navigate to https://localhost:3000 to open up the Fake Survey Generator UI

or

  1. Open FakeSurveyGenerator.sln in Visual Studio:

  2. Make sure that the docker-compose project is selected as the startup project

  3. Hit F5 to debug the application, or Ctrl + F5 to run without debugging

  4. In a browser, navigate to https://localhost:3000 to open up the Fake Survey Generator UI

To run on local Kubernetes:

To deploy to a local Kubernetes cluster:

  1. Create an entry in your hosts file as follows:

    127.0.0.1 k8s.local

  2. In a Terminal/Command Prompt/PowerShell window in the project root, run:

    skaffold run

  3. In a browser, navigate to https://k8s.local to open up the Fake Survey Generator UI

How do I contribute?

If you find a bug, want to add a feature, or want to improve the documentation, open up a PR!

References

My deepest thanks to all the people who provided these resources as reference:

Fake Survey Generator

A slightly more-than-trivial full-stack application built with DDD & CQRS concepts

Fake Survey Generator Info

⭐ Stars 23
🔗 Source Code github.com
🕒 Last Update 7 months ago
🕒 Created 2 years ago
🐞 Open Issues 0
➗ Star-Issue Ratio Infinity
😎 Author MarcelMichau