https://github.com/carbon-design-system/carbon-angular-starter

A simple starter app for bootstrapping applications with Carbon
https://github.com/carbon-design-system/carbon-angular-starter

angular carbon-components-angular carbon-design-system ibm starter-project

Last synced: 14 days ago
JSON representation

A simple starter app for bootstrapping applications with Carbon

• Host: GitHub
• URL: https://github.com/carbon-design-system/carbon-angular-starter
• Owner: carbon-design-system
• License: apache-2.0
• Created: 2018-11-20T21:17:09.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-05-23T14:24:53.000Z (6 months ago)
• Last Synced: 2024-07-31T19:54:45.824Z (3 months ago)
• Topics: angular, carbon-components-angular, carbon-design-system, ibm, starter-project
• Language: TypeScript
• Homepage: https://carbon-angular-starter.netlify.com/
• Size: 2.79 MB
• Stars: 75
• Watchers: 14
• Forks: 79
• Open Issues: 31
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-ibmcloud - carbon-angular-starter - A simple starter app for bootstrapping applications with Carbon components. (Carbon Design System)
• awesome-angular - carbon-angular-starter - A simple starter app for bootstrapping applications with Carbon. (Table of contents / Angular)
• fucking-awesome-angular - carbon-angular-starter - A simple starter app for bootstrapping applications with Carbon. (Table of contents / Angular)
• fucking-awesome-angular - carbon-angular-starter - A simple starter app for bootstrapping applications with Carbon. (Table of contents / Angular)

README

        
# CARBON ANGULAR STARTER

Kick start your application development with Carbon Angular.

## Prerequisites

* [node](https://nodejs.org/) and [npm](https://www.npmjs.com/) (Included with node)

* [git](https://git-scm.com/)

## Download and install

Run the following in the terminal:

```bash

# to download

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

# to install

cd carbon-angular-starter

npm i

```

## Development server

Run `npm run start` or `npx ng serve` for a dev server. Navigate to [http://localhost:4200/](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](https://angular.carbondesignsystem.com/) and [developer documentation](https://angular.carbondesignsystem.com/documentation/).

## Create new angular components

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

## Build

Run `npm run build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `-prod` flag (`npm run build -- -prod`) for a production build.

## Running unit tests

Run `npm test` to execute the unit tests via [Jest](https://jestjs.io/).

## Running end-to-end tests

Run `npm run e2e` to execute the end-to-end tests via [Cypress](https://www.cypress.io/).

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 `npx ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).