Internal Angular UI framework for Alauda Frontend Team.

• Online Demo
• Getting Started
  • Install
  • Project Config
  • Usage
• Development
• Test
• Build Storybook
• Build Library
• Incremental Builds
  • Parameter
  • Config File
• Read More
• LICENCE

Storybook Demo

# npm
npm i @alauda/ui

# yarn
yarn add @alauda/ui

and also need to confirm the peer dependencies have been installed

yarn add dayjs @angular/cdk

// tsconfig.json
{
  "compilerOptions": {
    "allowSyntheticDefaultImports": true,
    "skipLibCheck": true,
    ...
  },
  ...
}

import { ButtonModule } from '@alauda/ui';

@NgModule({
  imports: [ButtonModule],
})
export class AppModule {}

git clone https://github.com/alauda/alauda-ui.git
cd alauda-ui
yarn install
yarn start

开发环境基于 Storybook 运行，查看 文档。

yarn test

or

yarn test:watch

yarn storybook:build

yarn build

Develop and debug UI component libraries quickly and efficiently by incremental builds

yarn build:watch

Also can copy a dist to another project to debug

yarn build:watch <project_path>

In this way, after every incremental build completed, dist will be copied to node_modules which in specified project

In order to incremental build dist to your project directly instead of adding parameter to specify project path every time, can use your own ng-package.json by

npm run debug

Edit you own build config by adding a new file called ng-package.debug.json, like

// ng-package.debug.json
{
  "$schema": "./node_modules/ng-packagr/ng-package.schema.json",
  "dest": "/home/alauda/projects/<target_project_path>/node_modules/@alauda/ui",
  "lib": {
    "entryFile": "./src/index.ts"
  }
}

• coding standards
• contributing
• AOT notes

MIT © Alauda