Configuring the System - njc3006/TTKDSeniorProject GitHub Wiki

The Student Management System can be configured in two primary ways: by modifying the brand displayed in the navbar and changing the text that's displayed on the waiver screen during registration.

Note: Both of these sets of instructions assume you have already cloned the repository, so pleasure ensure that you have cloned the repository to a directory of your choice before following these steps.

Note: For the purposes of this article, we will refer to the folder in which the system is installed as TTKDFolder, please substitute this with whichever folder you are using when following these instructions.

Configuring the System Brand

The System Brand is the text that is displayed on the left-hand side of the navbar as in the screenshot below:

To configure this text, perform the following steps:

  1. Create a file called constants.js in the TTKDFolder/ttkd_ui/app folder.
  2. Open the file using any text editing software of your choice (e.g Notepad) and paste the following contents:
/*
 * Because our application is written with AngularJS, we decided to have some configuration be loaded through an Angular module.
 * We must create that module for the application to properly load its configuration
 */
(function() {
  angular.module('ttkdApp.constants', [])
    // This variable tells the UI where to look for the API it uses to get all the data and is needed to make the UI work.
    // By default the UI will look on the same machine on which it's hosted.
    // We recommend hosting the UI and API on the same machine.
    // Most use cases will not require this variable to be modified.
    // MODIFY THIS CONSTANT AT YOUR OWN RISK
    .constant('apiHost', '')

    // DO NOT FORGET THE SINGLE QUOTES: any custom text should be surrounded by a pair of single quotes.
    // If you do not want any custom text, simply leave a pair of single quotes like so: ''
    .constant('companyName', '<Your studio name here>');
})();
  1. Edit the value '<Your studio name here>' to include your desired text. Be sure not to forget the single quotes.
  2. Save the file.
  3. Build the UI (See Building the System).
  4. Once the process is complete, the newly built ui will be in the TTKDFolder/ttkd_ui/dist folder.
  5. Inside your TTKDFolder, double click `stop.bat to temporarily stop the system.
  6. Replace the contents of the TTKDFolder/static folder with the contents in the TTKDFolder/ttkd_ui/dist.
  7. Double click start.bat inside TTKDFolder to restart the application.
  8. The new system brand should now show up when accessing the system

Configuring the Content of the Waiver Screen

Our system allows for martial arts studios to customize the content of the waiver screen during registration. To do so perform the following steps:

  1. Create a file called waiver.txt in the TTKDFolder/static folder.
  2. Edit the new file so that it contains the text you want.
  3. Be sure to save any changes made.
  4. The next time the registration waiver screen is accessed, you should see the updated waiver text.

Note: In order to see any updated text, you may need to clear your browser cache

If the above steps are successful, the resulting waiver screen should look something like the picture below, except with your custom text in the place of the example text: