Skip to content

happy-geeks/geeks-core-library

Repository files navigation

GeeksCoreLibrary (GCL)

Build and test

Requirements

  1. Install .NET Hosting bundle on the server that is running the GCL: https://dotnet.microsoft.com/download/dotnet/6.0

Using the GCL in a project

If you're creating a new project, we recommend using the template for that. Simply click the green button "Use this template" to create a new repository that will be a copy of the template.

If you don't want to or can't use the template project, you have the do the following in order to use the GCL: Install the NuGet package GeeksCoreLibrary and then modify your Startup.cs to look like this:

public class Startup
{
    public Startup(IConfiguration configuration)
    {
        Configuration = configuration;
    }

    public IConfiguration Configuration { get; }

    // This method gets called by the runtime. Use this method to add services to the container.
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddGclServices(Configuration);
        services.AddControllersWithViews();
    }

    // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        app.UseGclMiddleware(env);
    }
}

Configuration

For the GCL to work, you need to set some values in the appSettings.json or appSettings-secrets.json:

{
  "GCL": {
    "connectionString": "", // The connection string to the database for this project.
    "DefaultEncryptionKey": "", // The default encryption key that should be used for encrypting values with AES when no encryption key is given.
    "DefaultEncryptionKeyTripleDes": "",  // The default encryption key that should be used for encrypting values with Tripe DES when no encryption key is given.
    "evoPdfLicenseKey": "" // If you're going to use the PdfService, you need a license key for Evo PDF, or make your own implementation.
  }
}