Skip to main content

Start with NuGet packages

Use these steps if you want to add SharpOMatic to an existing ASP.NET Core project.
You could start from scratch by creating a new ASP.NET Core project and then running these steps.

Install packages​

dotnet add package SharpOMatic.Engine
dotnet add package SharpOMatic.Editor

Register services​

Update Program.cs to add the required services. The following example stores library assets and a SQLite database in your user profile. This gets you up and running quickly and isolates the data to the current user.

For example, if your username is JohnDoe, then the files will be at:
C:\Users\JohnDoe\AppData\Local\SharpOMatic

  // Assets are stored in the current user's profile
  builder.Services.Configure<FileSystemAssetStoreOptions>(
    builder.Configuration.GetSection("AssetStorage:FileSystem"));
  builder.Services.AddSingleton<IAssetStore, FileSystemAssetStore>();

  builder.Services.AddSharpOMaticEditor();
  builder.Services.AddSharpOMaticTransfer();
  builder.Services.AddSharpOMaticEngine()
    .AddRepository((optionBuilder) =>
    {
      // SQLite database in current user's profile
      var folder = Environment.SpecialFolder.LocalApplicationData;
      var path = Environment.GetFolderPath(folder);
      var dbPath = Path.Join(path, "sharpomatic.db");
      optionBuilder.UseSqlite($"Data Source={dbPath}");
    });

The first 3 lines are used to setup how assets are stored. It uses the file system implementation which is the easiest for getting started. We want to use the browser based editor and so need to call AddSharpOMaticEditor. To enable import and export we then add AddSharpOMaticTransfer. Finally the AddSharpOMaticEngine call is used to setup the repository. For simplicity we use SQLite, it will create the database automatically on first start.

Map the editor UI​

  app.MapSharpOMaticEditor("/editor");

You only need a single mapping call which specifies the url path for exposing the editor. If you already use this path for other purposes then you can update this to something more appropriate.

Open visual editor​

Check the generated port number for new project in the launchSettings.json.
NOTE: Replace 9001 with your project specific port number

Use your favorite browser to open http://localhost:9001/editor