Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gabro authored May 6, 2024
1 parent f78dcf2 commit 8ab35e2
Showing 1 changed file with 13 additions and 20 deletions.
33 changes: 13 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,20 @@
# AngularLayoutComponents
# Angular Layout Components

This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 17.3.6.
Set of Angular Components for managing layout, inspired by [Bento DS Layout Components](https://developer.bento-ds.com/Guides/layout)

## Development server
## Usage
Refer to https://buildo.github.io/angular-layout-components

Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files.
## Contributing

## Code scaffolding
Install dependencies using

Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
```bash
npm install
```

## Build
then run the Storybook using

Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.

## Running unit tests

Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).

## Running end-to-end tests

Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.

## Further help

To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
```bash
npm run ng run layout-components:storybook
```

0 comments on commit 8ab35e2

Please sign in to comment.