Mycro

Light-weight framework for building micro services

Domain Driven Design using CQRSLite with optional use of Event Sourcing
Built-in storage using LiteDB
Automatic Discovery of Event/Command Handlers and WebApi Controllers
Automatic Notification of domain events using SignalR
Automatic generation of REST API documentation using Swagger
Automatic hosting of SPA (e.g. Angular) web application using Nancy
Scheduling using Quartz .NET

Frameworks Overview

Getting Started

Install nuget package

Make sure to change the target .NET framework of your project to 4.6

PM> Install-Package Televic.Mycro

Your first running application

Create a new class derived from the framework Startup class

using Televic.Mycro.Web;

namespace Mycro.Sample.Console
{
    public class SampleStartup : Startup
    {
        protected override string ApplicationName => "Sample";
    }
}

Now use this startup class in your application to start the service. Here is an example for a console application;

using Televic.Mycro.Web;

namespace Mycro.Sample.Console
{
    class Program
    {
        static void Main(string[] args)
        {
            new Server<SampleStartup>().Start();
        }
    }
}

This is it! You should now be able to run your application and see some logging. By default you can access the swagger ui at the following location: http://localhost:9000/swagger. This will be empty since we have no api controllers yet. Let's add one next.

Adding an API controller using LiteDB

ASP .NET WebApi controllers are automatically detected. Here is an example that allows us to store and retrieve customers to and from the database. Let's create a simple customer model class first:

using System.ComponentModel.DataAnnotations;

namespace Mycro.Sample.Console.Customers
{
    public class CustomerModel
    {
        [Required(AllowEmptyStrings = false)]
        public string FirstName { get; set; }

        [Required(AllowEmptyStrings = false)]
        public string LastName { get; set; }
    }
}

And now create a web api controller:

using System.Collections.Generic;
using System.Web.Http;
using LiteDB;

namespace Mycro.Sample.Console.Customers
{
    public class CustomersController : ApiController
    {
        private readonly LiteRepository _repository;

        public CustomersController(LiteRepository repository)
        {
            _repository = repository;
        }

        [HttpGet]
        public IEnumerable<CustomerModel> GetAllCustomers()
        {
            return _repository.Query<CustomerModel>().ToEnumerable();
        }

        [HttpPost]
        public void AddCustomer(CustomerModel model)
        {
            if (ModelState.IsValid)
                _repository.Insert(model);
        }
    }
}

Now you should be able to test your new api using the swagger ui. By default the application will look for a connectionstring with name {ApplicationName}DB (in this case SampleDB). If not found a default connection string will be used with database.db as filename for database.

pdeparcq / mycro