Ionic Training Decks

This material is meant to be used in conjunction with the Ionic Enterprise Training courses offered to our customers. The applications and labs contained within are some of the applications that are built during this course. This deck by no means contains all of the information provided in the course.

To run this deck on your machine:

1. git clone https://github.com/ionic-team/ionic-training-decks.git
2. cd ionic-training-decks
3. npm install
4. npm start

At this point, the training decks application should be running in your browser, allowing you to follow along with the specific labs.

This is also available online as a PWA that you can either run in the browser or install on your device: https://ionic-training-decks.firebaseapp.com

Developer Notes

Adding / Updating Trainings

Adding or updating trainings should not require a change to any of the source code. Here are some key points to help get started:

• All of the trainings are written as Markdown files and stored under src/assets/data/markdown.
• In order to provide better organization, sub-folders are used for each training.
• Simple one page trainings typically do not have their own sub-folder.
• Each training has an entry in the src/assets/data/menu.json file. The entry must have a title and file. It should also have an icon. If it is a multi-page training, it should also have a folder and list of pages. The pages are navigated via the navigation controls in the header of the application in the order in which they are specified.

The menu.json entry for a multi-page training looks like this:

    {
      "title": "Identity Vault",
      "folder": "identity-vault-capacitor",
      "file": "intro",
      "icon": "lock-closed",
      "pages": [
        {
          "title": "The Base Application",
          "file": "base"
        },
        {
          "title": "Identity Service",
          "file": "identity-service"
        },
        {
          "title": "Make it Work in the Browser",
          "file": "browser-service"
        },
        {
          "title": "Add Biometrics to Login",
          "file": "biometrics"
        },
        {
          "title": "Customize the PIN Dialog",
          "file": "custom-pin"
        }
      ]
    },

The menu.json entry for a simple single-page training looks like this:

    {
      "title": "A Simple git Workflow",
      "file": "simple-git-workflow",
      "icon": "git-branch"
    },

The trainings will be displayed in the main menu in the order in which they are specified.

Given the structure of the application, please only go one level deep with the trainings. That is, do not try and nest a list of pages on a page within a specific page on a training. That used to work in older versions of this application, but supporting it makes the UI overly complex and is a feature that was never used.

Commits and Changesets

1. You do not need to use conventional commits, but should still use a good commit description.
2. Significant commits must include a changeset (npx changeset) so the version is bumped properly.

There are no real rules on the versioning, but basically follow something logical. For example:

patch: Fixes to the application or trainings.

minor: New trainings added or whole new sections added to trainings.

major: Trainings removed or changed is such a significant was as to be considered "breaking."

If there is a question, don't sweat it, just pick what seems best to you.

Releasing

• Make sure you are on the main branch.
• Make sure all changes have been pushed to main and that you have all changes from origin.
• Make sure you are logged in to firebase as the support@ionic.io user

Once you have done that:

1. npm run bump to apply the changesets.
2. git commit for the release.
3. npm run build
4. firebase deploy