0.1.1 • Published 5 years ago

@rhi-isncsci-ui/mobile-sensory v0.1.1

Weekly downloads
1
License
Apache-2.0
Repository
github
Last release
5 years ago

:warning: These components are still a work in progress. :warning:

Introduction

rhi-ui-isncsci contains reusable user interface web components for the ISNCSCI project. We are currently using Google Polymer for our syntactic sugar.

#Why do I (EE) make you suffer with this? It has been my experience, after many years in the industry, that when it comes to the UI we let whatever framework we are using for an app dictate how the interface code will be written. As engineers we are always trying to build modular, reusable code but that has been a very challenging thing to achieve on the UI. JQuery and Atomic design got us close but not there yet. AngularJS moved us backwards in that respect. The recent Custom Elements Specification is finally moving us into the future and allows us to build well engineered components that can be reused, no matter what architecture is being followed. If it runs on the web platform, it will work. By following Clean Architecture approaches and web components standards we can finally live up to our loftiest engineering goals.

#Build polymer build

#Demo and Test

  1. In the root of the project folder run the tsc --p tsconfig-core.json command.
  2. In the root of the project folder run the npm run tsc command.
  3. Navigate to demo that you want to view to see the result (e.g. http://127.0.0.1:8081/demo/rhi-ui-isncsci-wide/)

#Contribute When working on this project, follow these steps: 1. Make sure you are working on a branch associated to a user story. 2. Add unit tests when appropriate. 3. When you are done building your component, add a demo page for it. 4. Review your changes and commit your code.

#Publish To update the npm package, so that the changes can be consumed by the apps: 1. Increase the package version in package.json. .. Currently, as we are in development, if the changes will break any of the apps, increase the minor version. .. If the changes enhance functionality and won't break any of the apps, just increase the patch version. .. Once we have a production build, stick to Semantic Versioning. 2. Run npm publish*

Publish mobile-sensory

  1. run tsc for the files under the build folder to be updated.
  2. run rollup -c ./rollup-configs/mobile-sensory/rollup.config.js.