Getting Started

Getting Started

Prerequisites: Node, Yeoman and Webpack.

• To install Node, visit nodeJS

• To install Yeoman and Webpack: npm install -g yo webpack

Next, install this generator:

npm i -g generator-at-angular

Creating a project:

mkdir MyAwesomeApp && cd $_
yo at-angular

Running a generator:

yo at-angular:page my-page                                   # Generates a page (partial)
yo at-angular:service my-service                             # Generates a service
yo at-angular:service my-component/my-service                # Generates a service in a component
yo at-angular:directive my-directive                         # Generates a shared directive
yo at-angular:directive my-component/my-directive            # Generates a directive in a component
yo at-angular:component my-component                         # Generates a component
yo at-angular:component my-component/my-nested-component     # Generates a nested component
yo at-angular:component my-component/my-nested-component/... # Generates a multiple nested component

Running the project:

npm start or npm run dev - To start development server on localhost:8080.

npm run build - To make production-ready build run after few moments you will see build id dist folder.

npm test - To run all tests once, should be used for the CI.

npm run tests - To run tests in watch mode.

npm run docs - To open the auto-generated docs in your default browser.

Out of the box optional supports:

• Angular Material: UI Component framework provides a set of reusable UI components based on Google’s Material Design. https://material.angularjs.org/latest/getting-started
• Boostrap Sass: bootstrap-sass is a Sass-powered version of Bootstrap

Tips:

• To keep the SASS/SCSS clean and modular use BEM Syntax
• To keep the git repository's branch model modular and scalable use git flow