The build process is a series of Gulp tasks and the HTTP server used is an NPM module. Because of this NodeJS is a prerequisites for working on this codebase.
Once you have the prerequisites installed and the repository cloned run the following command to install all dependent NPM modules and type definitions:
npm install
npm start
To run tests once:
npm test
To run tests continually as your are developing:
npm run watch:test
The src directory contains all of the source code for the application. When you have executed the npm start command, in addition to running the HTTP server to serve the web application from the dist folder, a series of Gulp tasks are kicked off to watch for changes to the files in the src folder and build them into the dist folder. This allows you to develop on the TypeScript (.ts) files and have those automatically compiled into JavaScript and placed in the folder being served. Also, any changes to HTML or CSS files are copied to the appropriate folder.
In addition to this, if you would like to have your unit tests run automatically as your are developing you open another terminal window and execute npm run watch:test. This will then execute all of your unit tests as well every time that you save a change to a file in the src directory. Unit tests exist in files with the extension .spec.ts.
Overview
├── dist - all of the compiled source code that comes out of the build process
├── src - directory housing all source code
│ ├── index.html - main index.html page
│ ├── app - all custom development files will go somewhere under
│ │ ├── account.model.ts - class defining a account
│ │ ├── account.service.ts - service functions for functionality regarding accounts
│ │ ├── account.service.spec.ts - tests for functions in account.service.ts
│ │ ├── accountCard.html - component template for accountCard.component.ts
│ │ ├── accountCard.component.ts - component that renders a card representing an account
│ │ ├── addAccount.html - HTML template servicing the addAccount modal popup
│ │ ├── addAccount.ts - controller servicing the addAccount modal popup
│ │ ├── app.module.ts - the main module file where the 'app' module is defined and all dependent modules are registered
│ │ ├── app.component.ts - the root component for the application
│ │ │ * this component contains the main set of data (accounts) for the application and exposes the functions that are used to maintain them
│ │ │ * the property containing the set of accounts and the functions are then passed down to other components to use
│ │ ├── app.config.ts - application configuration settings
│ │ ├── notifiation.service.ts - service functions that create messages for the users
│ │ ├── sideColumn.html - HTML template for sideColumn.component.ts
│ │ ├── sideColumn.component.ts - component representing the side column of the layout
│ │ ├── toolbar.html - HTML template for toolbar.component.ts
│ │ ├── toolbar.component.ts - component representing the toolbar at the top of the layout
│ ├── assets - all styles and image content should be placed under this directory
│ │ ├── app.css - custom LESS