Getting started with the Blueriq Material Theme

This will explain on how to get your own material theme up and running so you can start create your own theme based on this kickstarter

Setup the Blueriq Material Theme

The following steps should be taken to get the Angular based Blueriq Material Theme running

1. Download/fork our theme kickstarter here: https://github.com/blueriq/blueriq-material 
2. Configure the `proxy.conf.js` correctly. Read the README.md on how to set the environment variable
3. Configure the baseUrl in `environment.ts` 
4. Set up the base href (see the Base href section below)
5. https://my.blueriq.com/ApiDocs/npm-libs/blueriq-angular/0.6.16/additional-documentation/getting-started.html 
6. Remove the yarn.lock file that is distributed with the kickstarter theme (see yarn.lock section below)
7. Run the following command `yarn install` to install all packages
8. Run the following command `yarn start` to see your theme in action. This which will open up a browser that navigates to the `default` shortcut that you configured or use `localhost:4200/flow/<project>/<flow>` 
   For other possible routes please look at the `app.module.ts` routes.

Customization

The next step would be to customize it to your liking. Take a look at the theme folder and read the 'THEMING.md' to get the best practice on how to do so.

yarn.lock file

The yarn.lock file that is distributed with the kickstarter theme is used by Blueriq's CI servers. It references Blueriq's internal Artifactory server, as the CI servers cannot connect to the internet directly.

Therefore, when initially using the kickstarter project, you should remove the yarn.lock file before performing `yarn install`. You should check the resulting new yarn.lock file into your version control system.

Base href

Angular apps require a base href in order to find the proper resources. More information can be found in the Angular documentation on deployment.

The Blueriq Material theme contains some inline javascript code to determine the base href in case the theme is served from the Runtime itself, because the URL can differ per customer and per server. If you know the URL on which the Angular application runs beforehand, you are encouraged to remove the inline javascript code from index.html and configure the base_href statically, by including a hard coded <base href="/path/to/your/app">  tag or by specifying in the base href in angular.json .

In production

For more information on this subject please read the following: Angular and Deploying the theme