https://github.com/laixiangran/ng-xdesign-test
An enterprise-class UI components based on One Design and Angular 7.
https://github.com/laixiangran/ng-xdesign-test
angular component xdesign
Last synced: about 2 months ago
JSON representation
An enterprise-class UI components based on One Design and Angular 7.
- Host: GitHub
- URL: https://github.com/laixiangran/ng-xdesign-test
- Owner: laixiangran
- License: mit
- Created: 2019-03-31T14:06:40.000Z (about 7 years ago)
- Default Branch: develop
- Last Pushed: 2019-05-31T06:29:57.000Z (about 7 years ago)
- Last Synced: 2025-02-27T12:41:43.818Z (over 1 year ago)
- Topics: angular, component, xdesign
- Language: TypeScript
- Homepage: http://www.laixiangran.cn/ng-xdesign-test
- Size: 11.8 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# ng-xdesign-test
[](https://travis-ci.com/laixiangran/ng-xdesign-test)
[](https://codecov.io/gh/laixiangran/ng-xdesign-test)
[](https://github.com/laixiangran/ng-xdesign-test/releases)
[](https://www.npmjs.com/package/ng-xdesign-test)
[](https://www.npmjs.com/package/ng-xdesign-test)
[](https://github.com/laixiangran/ng-xdesign-test/blob/master/LICENSE)
## start
```base
npm install ng-xdesign-test@latest
```
```javascript
import { NbButtonModule } from "ng-xdesign-test";
@NgModule({
imports: [
NbButtonModule
]
})
```
```html
```
## develop
```bash
$ npm install
$ npm start
```
## commit
include `git commit` and `git push`
```bash
npm run commit -- -m 'type(scope): subject'
```
[AngularJS Git Commit Message Conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#)
## lint
```bash
$ npm run lint
```
## test
```bash
npm run test-once
or
npm run test-watch
```
## e2e
```bash
npm run e2e
```
## build
```bash
npm run build
```
## release workflow
### merge develop
```
git checkout master
git merge develop
```
### release
```
npm run release
```
发布之后，可以去 [travis](https://travis-ci.com/laixiangran/ng-xdesign-test) 查看最新的发布情况。
如果没有问题，过几分钟后，travis 任务会自动推送最新的版本到 npm
### merge master and push
```
git checkout develop
git merge master
npm run commit -- -m 'type(scope): subject'
```
## Compose a component
Component code are in `src/component`.
You can use `npm run gc` to quickly scafford a component.
```bash
$ npm run gc -- --name your-component
```
A `your-component` folder will be created in `src/component`, and the contents are:
```bash
your-component
├── index.ts
├── public_api.ts
├── your-component.config.ts
├── your-component.html
├── your-component.less
├── your-component.module.ts
└── your-component.ts
```
and it will add your component entry to `src/component/index.ts`.
## Write a demo for your component
You can then write a demo to test your component in `src/demo`.
When you use `npm run gc -- --name your-component`, a folder will be generated in `src/demo` too.
```bash
your-component
├── index.ts
├── your-component.html
├── your-component.less
└── your-component.ts
```
But you will still config the `src/demo/app.router.ts` and `src/demo/app.module.ts`.