yvlawy / etagair-configurator-api Goto Github PK

1.0 1.0 0.0 295 KB

General purpose Configurator API/Library for products, services and more...

C# 100.00%

dotnet csharp configurator library api netcoreapp config configuration configuration-management

etagair-configurator-api's Introduction

What is Etagair?

Etagair is a general purpose Configurator API for modeling and managing products, services, or everything else.

It's developed in C# language based on .NET Standard 2.0 and it is provided as a set of several libraries. It's a back-office API, there is no UI. Data are saved in a embedded database.

For more details, see the wiki

Key features

-Embedded .NET family assembly, platform independent with reference to one library: LiteDB, A lightweight embedded .NET NoSQL document store in a single datafile.

-Management of complex objects : entities with properties (list of key-value).

-Entities are organized hierarchically in folders.

-Creation of complex entities based on template.

-Localized media, only text for now (by using text code).

-Rich search of entities by properties criteria.

Getting started

Using clauses

Create a C# application. Import the Nuget package (see the link below). In the program, include these using:

  using Etagair.Core.System;
  using Etagair.Engine;

Create the engine and the database

These lines of code create the engine object. The init method create the database or use the existing one.

  EtagairEngine engine = new EtagairEngine();

  // the path must exists, it's the location where to put the database file
  string dbPath = @".\Data\";

  // create the database or reuse the existing one
  if (!engine.Init(dbPath))
  {
    Console.WriteLine("Db initialization Failed.");
    return;
  }

  // the database is created or reused and opened, it is ready to the execution
  Console.WriteLine("Db initialized with success.");

Create a folder within an entity

For example, create a folder named "computers", under it, add an entity having two properties. An entity haven't a name. Property of an entity is key-value pair.

The data:

F:computers\
  E:   
  "Name"= "Toshiba Satellite Core I7"
  "Trademark"= "Toshiba"

The Code:

// create a folder, under the root
Folder foldComputers = engine.Editor.CreateFolder(null, "computers");

// create an entity, under the computers folder
Entity toshibaCoreI7 = engine.Editor.CreateEntity(foldComputers);

// add 2 properties to the entity (key - value)
engine.Editor.CreateProperty(toshibaCoreI7, "Name", "Toshiba Satellite Core I7");
engine.Editor.CreateProperty(toshibaCoreI7, "Trademark", "Toshiba");

Package on Nuget

The application is ready to use and is available on Nuget. The last version is 0.0.5-alpha.

The web site: https://www.nuget.org/packages/Etagair/

The last release: https://www.nuget.org/packages/Etagair/0.0.5-alpha

etagair-configurator-api's People

Contributors

Stargazers

Watchers

etagair-configurator-api's Issues

Adds new types to entity property template

Entity property now have more type: double, int, and bool.
Adds these types to property templates.

Manage main region/country language and localized text

Define a country/region main (default) language.

exp: for en (English), the en-gb is defined as the main language.
If this case, if the current language si Something like en-us (or en-ca or Something else), if no localzed text is defined in en-us, then the application will get the localized text defined in the main language: en-gb.
If no text is defined for this language, the application will get the text for the main (neutral) language defined in the application.

engine.Editor.DefineMainLanguageRegion(LanguageCode.en_GB);

Search entity - Improvement

Can't search entity from the root folder.
Need to define the scope:
-All: Search from the root folder, and go Inside sub-folders.
-RootOnly: Search from the root folder, Don't go Inside subfolders. Scan only directs entities childs.
-Defined: Set/Defined source folders.