vlschematics

VLSchematics

This is an Angular schematics repository for building Frontend Applications in te Visual Lease desing system.

Quickstart

Enter the following into the terminal to spin up a new VL frontend project called "my-app"

$ npm install -g @angular/cli @schematics/angular
$ npm install -g vlschematics
ng new --collection vlschematics --name my-app

You can now serve up the demo app!

$ cd my-app
$ ng serve

Installation

First install the angular cli and schematics projects globally.

$ npm install -g @angular/cli @schematics/angular

Next install the vlschematics projects.

$ npm install -g vlschematics

Generating a new VL Frontend App

Starting a new frontend project from scratch

Use angular's ng new command and pass in vlschematics for project setup.

$ ng new --collection vlschematics --name your-project-name

OR Add our frontend dependencies to an existing angular project

Just add the vlschematics project to an existing angular project.

ng new --name your-project-name
ng add vlschematics

Updating the frontend template and publishing a new version of this schematics library

*Note - You probably came here from "Updating the VLSchematics template" in teh Reference Implementation project. Welcome!

1. Clone this repo, if you don't already have it

$ git clone https://visuallease.visualstudio.com/Lightmatter/_git/VL-MS-UI-SchematicsTemplate vlschematics
$ cd vlschematics

1. Initialize submodule link to the Reference Implementation project, if you haven't already

$ git submodule update --init

2.1 To pull an updated submodule

$ git submodule update --remote

1. Commit your changes to master

$ git commit -m "Update the template"

1. Push your changes

$ git push

1. Bump the version

$ npm version patch

1. Build the updated package

$ npm run build

1. Publish your changes!

$ cd dist && npm publish && cd ..

Testing

To test locally, install @angular-devkit/schematics-cli globally and use the schematics command line tool. That tool acts the same as the generate command of the Angular CLI, but also has a debug mode.

Check the documentation with

schematics --help

Unit Testing

npm run test will run the unit tests, using Jasmine as a runner and test framework.

Publishing

To publish, simply do:

npm run build
npm publish

That's it!