CARBON ANGULAR STARTER

Kick start your application development with Carbon Angular.

Prerequisites

• npm (brew install npm)
• git (brew install git)
• angular-cli (sudo npm install -g @angular/cli)

Download and install

Run the following in the terminal:

# to download
git clone https://github.com/carbon-design-system/carbon-angular-starter.git

# to install
cd carbon-angular-starter
npm install

Development server

Run npm run start or ng serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

How to use components

Look at the component library and developer documentation.

Create new angular components

Run ng generate component component-name to generate a new component. You can also use ng generate directive/pipe/service/class/module.

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the -prod flag for a production build.

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor. Before running the tests make sure you are serving the app via ng serve.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.

PWA ready

Carbon Angular Starter was built with offline and progressive web app in mind.

It provides manifest.json and service worker (sw.js).

In order to simplify development, service worker is not activated by default as this may get in the way of your workflow. If you're actively working on customizing your service worker or doing testing, remember to activate it by uncommeting the script tag content in index.html.