Telepath is a distributed application for assistance in the investigation of potentially paranormal phenomena, specifically extrasensory perception. It allows members in a group to submit thoughts at specific times, after which Telepath identifies commonly conceived thoughts as candidates for further study in the context of telepathy.
Members belong to one or more ThinkGroups and submit Thoughts each pertaining to a particular Topic along with a time at which the thought occurred. Reports are generated regularly and on an ad hoc basis to highlight temporal and subjective commonalities between thoughts between Members of a ThinkGroup.
Telepath follows a general onion architectural style. In the center is Core, upon which all other projects depend. One level up is DataAccess, which serves as an intermediary between the database and the distributed app. On the periphery are the Api, Web, Worker, and Tests projects, all of which depend upon Core and DataAccess.
Telepath.Web and Telepath.Api are two independently deployable units to facilitate independent scaling based on traffic. If Telepath is used primarily by way of mobile app and other direct API calls, then Telepath.Api will likely scale more quickly than Telepath.Web to support traffic. If the web interface is the main source of demand, then Telepath.Web will likely scale commensurately with respect to Telepath.Api
Core contains the domain classes, that is to say the model of the domain, where the structure and business logic reside. All other projects depend on Core.
DataAccess is where the logic that serves and manipulates database structures as domain objects. DataAccess uses Entity Framework as its object-relational mapper (ORM) and is designed by default to use MSSQL as its underlying data store.
Api is the RESTful Web API service that acts as the primary external interface for access to the data layer. Calls to this service may also result in events and commands being added to the bus.
The Worker processes events and commands from the bus, directly manipulating the database using DataAccess as well as creating additional events and commands to be queued onto the bus.
Web contains two projects that compose the UI that allows human interaction with Telepath:
The reactapp project serves as the most peripheral interface, hosted in React, that presents content to the user and accepts input to the rest of the app.
The webapi project brokers communication between the reactapp interface and other components within the Telepath solution. As such, it depends weakly on the Api service. Web should not directly read or write to the database.
Web, along with the Tests project, are on the outermost periphery of the solution.
Tests project contains automated unit, integration, and system tests designed to ensure maximal congruence between Telepath's requirements and operation.
Logger: Serilog IoC container: Autofac Database: Microsoft SQL Server Object-relational mapper: Entity Framework Message broker: RabbitMQ Service bus: MassTransit API scaffolding: Swagger Automated tests: MSTest
Set ConnectionStrings.Telepath to a valid MSSQL connection string in Api, Web, and Worker projects.
Telepath is provided free of charge under MIT license terms. Do with it what you will without expectation of warranty or liability from the author (me).
If you find Telepath or any part of it useful, please let me know! I'd love to hear your thoughts on it.