diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 447aec7..c371524 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,3 +1,3 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or -contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. \ No newline at end of file +contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7d71903..7e66c4b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,6 +14,7 @@ For more information see the [Code of Conduct FAQ](https://opensource.microsoft. or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. ## Pull Requests Reviews + This is a simple guide to assist in reviewing Github pull requests locally within VS Code. See: https://gist.github.com/piscisaureus/3342247 @@ -66,4 +67,4 @@ Fast-forward ... ``` -Note: "git pull" did not work for me by itself for the PR branch... Perhaps "git pull origin". \ No newline at end of file +Note: "git pull" did not work for me by itself for the PR branch... Perhaps "git pull origin". diff --git a/README.md b/README.md index 59a5c46..99c8f2c 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,12 @@ [![npm version](https://badge.fury.io/js/%40angular-react%2Fcore.svg)](https://www.npmjs.com/package/@angular-react/core) -Industry trends, organizational pressures, and other factors can lead to mandates regarding the use of component libraries or migration from one technology to another. In the case of [Office UI Fabric][fab], where its use is required, the client must be written in React (there is no Angular component library for the latest version). Rewrite from Angular to React may be cost-prohibitive or ill advised for other reasons. +Industry trends, organizational pressures, and other factors can lead to mandates regarding the use of component libraries or migration from one technology to another. In the case of [Office UI Fabric][fab], where its use is required, the client must be written in React (there is no Angular component library for the latest version). Rewrite from Angular to React may be cost-prohibitive or ill advised for other reasons. -Use of Angular-React allows consuming any React elements, but specifically Office UI Fabric, within an Angular [2+] application. The library of wrappers for Office UI Fabric simplifies the use of these components with Angular. However, any React code can make use of the custom Angular-React renderer. +Use of Angular-React allows consuming any React elements, but specifically Office UI Fabric, within an Angular [2+] application. The library of wrappers for Office UI Fabric simplifies the use of these components with Angular. However, any React code can make use of the custom Angular-React renderer. ### Quick links + [@angular-react/fabric](https://www.npmjs.com/package/@angular-react/fabric) | [Documentation, quick start, and guides][ard] | [Demo][ard-demo] | @@ -15,15 +16,18 @@ Use of Angular-React allows consuming any React elements, but specifically Offic [Office UI Fabric](https://developer.microsoft.com/en-us/fabric) ### Typical Use Cases + - Use React component libraries with Angular - Incrementally rewrite an Angular application into React (moving from atomic/leaf nodes upward into full features/pages until the entire app is re-written) ## Libraries + - [**core**][lib-core]: Includes the Renderer and supporting logic to render Angular components with React implementations as React components. - [**fabric**][lib-fab]: The light-weight Angular component wrappers that expose the Fabric React component api through common Angular components (including both imperative AND declrative syntax in many cases). # Roadmap -Initial work to prove the feasibility of adapting the Angular Renderer to output React managed components has concluded. We have moved beyond the initial simple Fabric components and expanded coverage to much of the available [Office UI Fabric][fab-c] component library. + +Initial work to prove the feasibility of adapting the Angular Renderer to output React managed components has concluded. We have moved beyond the initial simple Fabric components and expanded coverage to much of the available [Office UI Fabric][fab-c] component library. In the coming months we will continue to refine the component implementations as we use the angular-react core and fabric libraries in 2 real-world consumer facing production applications. @@ -41,4 +45,4 @@ You can look through the issues (which should be up-to-date on who is working on [fab]: https://developer.microsoft.com/en-us/fabric [fab-c]: https://developer.microsoft.com/en-us/fabric#/components [lib-core]: https://www.npmjs.com/package/@angular-react/core -[lib-fab]: https://www.npmjs.com/package/@angular-react/fabric \ No newline at end of file +[lib-fab]: https://www.npmjs.com/package/@angular-react/fabric diff --git a/apps/demo/karma.conf.js b/apps/demo/karma.conf.js index 6ccac29..de8d4b2 100644 --- a/apps/demo/karma.conf.js +++ b/apps/demo/karma.conf.js @@ -1,8 +1,7 @@ - // Karma configuration file, see link for more information // https://karma-runner.github.io/1.0/config/configuration-file.html -module.exports = function (config) { +module.exports = function(config) { config.set({ basePath: '', frameworks: ['jasmine', '@angular-devkit/build-angular'], @@ -11,15 +10,15 @@ module.exports = function (config) { require('karma-chrome-launcher'), require('karma-jasmine-html-reporter'), require('karma-coverage-istanbul-reporter'), - require('@angular-devkit/build-angular/plugins/karma') + require('@angular-devkit/build-angular/plugins/karma'), ], client: { - clearContext: false // leave Jasmine Spec Runner output visible in browser + clearContext: false, // leave Jasmine Spec Runner output visible in browser }, coverageIstanbulReporter: { dir: require('path').join(__dirname, '../../coverage'), reports: ['html', 'lcovonly'], - fixWebpackSourcePaths: true + fixWebpackSourcePaths: true, }, reporters: ['progress', 'kjhtml'], port: 9876, @@ -27,7 +26,6 @@ module.exports = function (config) { logLevel: config.LOG_INFO, autoWatch: true, browsers: ['Chrome'], - singleRun: false + singleRun: false, }); }; - \ No newline at end of file diff --git a/apps/demo/src/404.html b/apps/demo/src/404.html index b453931..eb38bfe 100644 --- a/apps/demo/src/404.html +++ b/apps/demo/src/404.html @@ -1,27 +1,19 @@ +
+ - - +