Cinnamon - Toastmasters Meeting Agenda Generator

Overview

Cinnamon is a self-contained Angular SPA web application for generating Toastmasters Meeting Agendas.
https://sbartholomeusz.github.io/cinnamon/

The application was developed with the following constraints in mind:

• Toastmasters International does not provide official tools to generate club meeting agendas (at least at the time of development).
• The solution must be easy to access, and therefore ideally web based.
• Toastmasters Clubs are run by volunteers therefore minimising the complexity and on-going maintenance of the application is vital. A self-contained solution would be the most ideal option.
• Hosting costs for the web application should also be minimised.
  
  

Notable third party dependencies include:

• awesome-qr - https://www.npmjs.com/package/awesome-qr
• angular-cli-ghpages - https://www.npmjs.com/package/angular-cli-ghpages
• datetime-picker - https://www.npmjs.com/package/@angular-material-components/datetime-picker
• print-js - https://www.npmjs.com/package/print-js
  
  

Configurations

Please take note of the following configuration files that will require amending.

• Toastmasters Club JSON data file - \src\src\assets\tm-club.json

How to: Run the web application locally

1. Clone the repo

git clone https://github.com/sbartholomeusz/cinnamon

2. Install dependencies

cd cinnamon\src\
npm install

3. Serve the angular web application

ng serve

Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

How to: Build the solution

Run ng build to build the project. The build artifacts will be stored in the dist/ directory.

How to: Run unit tests

Run ng test to execute the unit tests via Karma.

How to: Debug unit tests

Run ng test --browsers ChromeDebug to execute the unit tests via Karma.
Then run script ng test debug.