Getting Started

Install template

We have created a dotnet project template for you to start your new project using dotnet new.

To install the template just run the following dotnet install command:

dotnet new --install BQStartPrimeTemplate

Create new project

mkdir myapp
cd myapp
dotnet new bqstart-prime -n myapp

The above will create a new project structure with a data and web project inside the solution.

Install NPM Packages

Navigate to myapp.Web\ClientApp folder in your terminal and run yarn or npm to install packages

yarn install

Configuration

Update AppSettings.json

Open the appSettings.json file and modify the default user id, and password as desired. It is recommended that you store the password in the user secrets file.

"defaultLoginEmail": "<>",
"defaultPassword": "<>",

You can also specify other settings like SMTP server. For details refer to configuration page.

Update Startup.cs

You can also modify default settings in the Startup.cs class:

//---------------------------------------------------------------------------------------------
//BQ Admin related
//---------------------------------------------------------------------------------------------
services.AddBqAdminServices<ApplicationUser, MainDataContext>(options =>
    options.SetApplicationName("myapp bqStart")
    //allow open user registrations
    .SetAllowUserRegistration(false)
    //change default timezone
    .SetDefaultTimeZone(TZConvert.GetTimeZoneInfo("UTC"))
    //change default language
    .SetDefaultLanguage("en_AU")
    .SetSecurityRulesProvider(new FileBasedSecurityRulesProvider("config"))
    //register all OData controllers here
    .RegisterController<IdentityRole, IdentityRoleController>()
    .RegisterController<ApplicationUser, ApplicationUserController>()
    .RegisterController<DemoCustomer, DemoCustomerController>()
    );

For details refer to the backend page.

Angular Project Configurations

The angular project resides in the ClientApp folder. You will see the app.config.ts file where most of the app configuration resides.

applicationName: 'Template1',
logoUrl: 'assets/images/logo.png',
companyName: 'Binary Quest',
viewDefaults: { defaultPageSize: 50, otherPageSizes: [25, 50, 100] },
tabbedUserInterface: false,

Compile and Run

By default, the angular project is set to run as a proxy mode. This means you will have to run "ng serve" in a terminal before you can start debugging the project from Visual Studio. To keep things simple we use VS Code for Angular projects and Visual Studio for backend websites. You also need to make sure you have localdb of MS SQL installed.