name sdk

NAME: A C# library for managing service dependencies, simplifying dependency problem detection in complex applications. It offers human and machine-readable dependency information without external tools. This document details its features, installation, usage, and contribution guidelines.

NAME: Self-Contained Dependencies Management

NAME is a service dependencies management library designed to expose and access services information, written in C#.

Its goal is to make it easier and simpler to detect service dependencies problems in a world where there are more and more services per application. It provides human and machine friendly dependencies information without the need for external tools.

Main Features

Getting Started

Installing on ASP.NET Web API

The configuration file is present in App_Start/NAMEConfig.cs and the dependencies definition file is dependencies.json.

Installing on ASP.NET Core

Non-Web Applications

For applications without a web server we created a SelfHost solution.

You can read how to install NAME on those applications at Using NAME On Non Web Applications.

Documentation

See the Wiki for full documentation, examples, operational details and other information.

Building and testing

We define our build using Cake, this allows us to define a common ground for developers on different operating systems, but it requires .Net 4.5 or Mono 4.2.3, so make sure you have those dependencies setup.

Bootstrap scripts are provided for both Windows and Linux environments. Keep in mind that not all tests will run on Linux, because some projects are targeting .NET 4.5+.

To build and run unit tests on Windows execute the command:

To build and run unit tests on Linux execute the command:

Contributing

We really appreciate your interest in contributing to NAME.

All we ask is that you follow some simple guidelines, so please read the CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.

Thank you, contributors!

License

Copyright © NOS Inovação.

This project is licensed under the BSD 3-Clause License - see the LICENSE file for details