Getting Started

When creating a new project, you want to create a .NET Core 3/.NET 5 Console Project (for all platforms - Windows, Linux, MacOS) or a .NET Framework Console Project for Windows.

Visual Studio 2022/2019, JetBrains Rider or Visual Studio Code is preferred but any Editor can be used.

Chromely ONLY supports x64 application. Developers can try x86 too but will not be supported.

A simple Chromely project requires:

ThreadApt.STA();

AppBuilder
   .Create(args)
   .UseApp<ChromelyBasicApp>()
   .Build()
   .Run();

Chromely is configurable and extensible.

To run a Chromely app, 3 primary objects can be configured. Other services/objects can be registered using .NET Extensions Dependency Injection in the application class.

Full application builder options:

ThreadApt.STA();

AppBuilder
   .Create(args)
   .UseConfig<CustomConfiguraton>()
   .UseWindow<CustomWindow>()
   .UseApp<CustomChromelyApp>()
   .Build()
   .Run();

ThreadApt.STA();

AppBuilder
   .Create(args)
   .UseConfig<CustomConfiguraton>(new CustomConfiguraton())
   .UseWindow<CustomWindow>(new CustomWindow())
   .UseApp<CustomChromelyApp>(new CustomChromelyApp())
   .Build()
   .Run();

Custom Application Class - required

To create a Chromely application, a custom application class (or/and instance) is required. The class can inherit the base class implementation:

• ChromelyBasicApp

Window Class - optional

To create Chromely application, the Window class is not required. A custom window class must implement - IChromelyWindow or inherit from Window. A custom Window type/instance can also be registered using .NET Extensions Dependency Injection.

Configuration Class - optional

The Chromely configuration is equivalent to Desktop App.config or Web project Web.config/appsettings.config. To create Chromely application, the Configuration class is not required. A custom configuration class must implement - IChromelyConfiguration. A custom configuration type/instance can also be registered using .NET Extensions Dependency Injection.

• If no configuraton file is found, it uses the default - DefaultConfiguration.