From 3405a42d4434bb77026c029ed20f2898ba665107 Mon Sep 17 00:00:00 2001 From: fengxiang <110431245@qq.com> Date: Thu, 11 Jan 2018 09:25:50 +0800 Subject: [PATCH] 框架升级 --- README.md | 105 +++++++++++++++++++++++++++++++++++++++++++++------- 1 files changed, 91 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 051306d..939d3a6 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,104 @@ -# ScreenFrontend +[](https://travis-ci.org/cipchk/ng-alain) +[](https://david-dm.org/cipchk/ng-alain) +[](https://www.npmjs.com/package/ng-alain) -This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 1.6.0. +# ng-alain -## Development server +[Ng-zorro-antd](https://github.com/NG-ZORRO/ng-zorro-antd) admin panel front-end framework. -Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files. +���������������[������ README](README-zh_CN.md) -## Code scaffolding +[DEMO](https://cipchk.github.io/ng-alain/) -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`. +## Quick start -## Build +Make sure you have Node version >= 6.9.0 and NPM >= 3 or higher. -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. +```bash +# clone a blank ng-alain repo, just only basic function +# --depth 1 removes all but one .git commit history +git clone -b blank --depth 1 https://github.com/cipchk/ng-alain.git +# or full master branch +git clone --depth 1 https://github.com/cipchk/ng-alain.git -## Running unit tests +# change directory +cd ng-alain -Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io). +# install npm package +npm install +# in china please use cnpm ���https://github.com/cnpm/cnpm��� +# cnpm install -## Running end-to-end tests +# start the serve +npm start -Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/). +# use HMR +npm run serve:hmr +``` -## Further help +> [vscode] recommended install [ng-zorro-vscode](https://marketplace.visualstudio.com/items?itemName=cipchk.ng-zorro-vscode) plugins, that includes `nz-alain-*` snippets. -To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md). +## Links + ++ [Document](http://ng-alain.com) ++ [@delon](https://github.com/cipchk/delon) ++ [DEMO](https://cipchk.github.io/ng-alain/) + +## Delon + +[delong](https://github.com/cipchk/delon) is a production-ready solution for admin business components packages, Built on the design principles developed by Ant Design. + +[](https://travis-ci.org/cipchk/delon) +[](https://david-dm.org/cipchk/delon) +[](https://david-dm.org/cipchk/delon?type=dev) + +[](https://www.npmjs.com/package/@delon/theme) +[](https://www.npmjs.com/package/@delon/theme) + +| package name | version | next version | +| ------------ |:-----:|:----------:| +| @delon/theme | [](https://www.npmjs.com/package/@delon/theme) | [](https://www.npmjs.com/package/@delon/theme) | +| @delon/abc | [](https://www.npmjs.com/package/@delon/abc) | [](https://www.npmjs.com/package/@delon/abc) | +| @delon/acl | [](https://www.npmjs.com/package/@delon/acl) | [](https://www.npmjs.com/package/@delon/acl) | +| @delon/auth | [](https://www.npmjs.com/package/@delon/auth) | [](https://www.npmjs.com/package/@delon/auth) | +| @delon/mock | [](https://www.npmjs.com/package/@delon/mock) | [](https://www.npmjs.com/package/@delon/mock) | +| @delon/cache | - | [](https://www.npmjs.com/package/@delon/cache) | +| @delon/cli | - | [](https://www.npmjs.com/package/@delon/cli) | + +## Architecture + + + +## Features + ++ `ng-zorro-antd` based ++ Responsive Layout ++ I18n ++ ACL ++ Lazy load Assets ++ UI Router States ++ Multiple color options ++ Less preprocessor ++ Well organized & commented code ++ Simple upgrade ++ Hot Module Replacement ++ Support [Docker](_documents/docker.md) deploy + +## App Shots + + + + + +## Troubleshooting + +Please follow this guidelines when reporting bugs and feature requests: + +1. Use [GitHub Issues](https://github.com/cipchk/ng-alain/issues) board to report bugs and feature requests (not our email address) +2. Please **always** write steps to reproduce the error. That way we can focus on fixing the bug, not scratching our heads trying to reproduce it. + +Thanks for understanding! + +### License + +The MIT License (see the [LICENSE](https://github.com/cipchk/ng-alain/blob/master/LICENSE) file for the full text) -- Gitblit v1.8.0