Code Monkey home page Code Monkey logo

inquizitarium's Introduction

Welcome to Inquizitarium !!!

Inquizitarium - is a platform for creating survival quests with a built-in Quiz system.

Check the How to Play? guide to get started and have some FUN!


OpenAPI

There is OpenAPI documentation (Swagger) available for the project.

Once you are set up, navigate to /swagger url (by default https://localhost/swagger) to see it.

Technical overview

This project is built as a Modular Monolith in adhere to Domain Driven Design and using Event Storming modeling technique.

NOTE: the understanding of DDD and Event Storming may differ from one person to another. This project is just my own sandbox to try out DDD in practice. It might be full of mistakes, misconceptions and cognitive distortions, so, please, treat it accordingly :)

There are 4 modules in /src directory

  • Core - a base module containing common (shared) functionality used by other modules.
  • Math - a module encapsulating Math domain (arithmetic expressions, operators, etc.)
  • Quiz - a module representing the key application domain. This module contains 3 submodules:
    • Creator - a module responsible for creating/generating Quizzes
    • Checker - a module responsible for checking Quizzes
    • ResultsStorage - a module responsible for persisting Quiz Results provided by Quiz Checker module
  • Quests - a module with all Quests using different UI (Cli, Web, etc.)
    • "The Shelter Demo" quest demonstrates a short simplified example how Quiz modules can be integrated into Web applications via Rest API
    • "The Dwarf Kingdom" quest implements CLI approach using a CommandBus to communicate with Quiz modules

Dependency rules between modules are described in deptrac-modules.yaml file in project root.

Dependency rules of DDD layers (Domain, Application, Infrastructure) are specified in deptrac-layers.yaml.

Event Storming

Check the Event Storming page to know more about this technique and how it was used in this project.

inquizitarium's People

Contributors

onenevan avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.