Quick Start Guide

This will cover the basics, including some fundamental concepts. You probably should read this all the way through as ,fortunatally for you, the way my mind works is different from yours.

JQuery

If you aren't familier with JQuery getting JSPA to do what you want might be confusing and frustrating (it might be even if you are).

Directorys

Application

This directory contains all of the framework logic, it has the classes to control routing, access to APIs, writing data to local storage (and indexedDB). It also contains a utils class to hold some general functions. This directory is essentially JSPA and you don't need to change anything in here.

Components

This is where all your application logic goes. Each component can be seen as either a whole page or a reusable section of a page. Most (if not all) of your development work will be inside this directory.

Any similarity to Components in other frameworks and languages is entirly co-incidental!

dist

The dist directory contains transpiled versions of the TypeScript classes, and Scss files. It also contains the raw javascript and css files used by other frameworks and plugins, in here you will find jQuery and bootstrap files, and is the place to put any jQuery plugins you might need.

Scripts

At present this simply contains the typings.d.ts files. There is a generic file (called typings.d.ts) where you can add typings for jQuery plugins that come as raw javascript.

Scss

Yes, you've guessed it - in here go the Scss files used for styling your web application. These should all be included as @includes into the main app.scss file as only this one gets transipler. This way there should only ever be a single .css file to hold all the application styles.

Services

This probably needs renaming - as it now holds a single file called pipes.ts. In this file you add any logic for display when databinding. Each pipe is simply a function that takes a string, manipulates it in some way and then returns a string.