README.md

TinyGU

Requirements

• https://angular.io/
• https://material.angular.io/
• https://github.com/angular/flex-layout
• https://github.com/trimox/angular-mdc-web (only for the mdc-textfield-box)

Automatic deployment on GitHub Pages

DEMO at https://physikonline-ffm.github.io/tinyGU

via Travis CI the Project is automatically built and pushed to the gh-pages branch. The .travis.yml-config file is in the root directoy. Branches with the suffix nobuild or nb seperated by . - _ / \ are not built on travis.

Not set up yet but generally possible would be an integration of greenkeeper.io which automatically updates the packages for the builds at travis.

Material Color Style

https://material.io/color/#!/?primary.color=005ea8

http://mcg.mbitson.com/#!?mcgpalette0=%23005ea8

Angular CLI

This project was generated with Angular CLI version 1.4.9.

Development server

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.

Alternatively when using Webstorm, you can set up a run command. Open "edit configurations" in the "Run" Menu. Add a "Bash" configuration. Now put in your Interpreter Path (cmd on Windows should be located at C:\Windows\system32\cmd.exe ). And as Interpreter options enter /k ng serve --port 4200. now you can run the server by simply running the project.

ng serve --i18nFile src/locale/messages.de-DE.xlf --i18nFormat xlf --locale de --missingTranslation ignore -p 4200

Build Angular App

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.

Dev

update Angular

to update Angular: https://angular-update-guide.firebaseapp.com/

npm outdated, npm update and npm ls --depth=0 are very handy commands

replace the version number @'^5.0.0' with @latest and probably add --save to the end of the command. On windows run cmd as admin!

to update Angular-CLI: https://github.com/angular/angular-cli#updating-angular-cli

if webpack is missing (ng version) install it with npm install --save-dev webpack

npm-check-updates makes it very easy to update packeges if you dont want use greenkeeper.io run ncu -x typescript -u -a

i18n

to generate the source file: ng xi18n --locale en-US --i18nFormat=xlf --outputPath src/locale --out-file messages.en-US.xlf

transifex

https://docs.transifex.com/client/installing-the-client

tx init dont change Transifex instance and get a token from https://www.transifex.com/user/settings/api/

tx set --auto-remote https://www.transifex.com/physikonline/tinygu

https://github.com/PhysikOnline-FFM/tinyGU/tree/master/src/locale/messages.en-US.xlf

tx push --source

tx pull --all

https://docs.transifex.com/integrations/github#section-integrating-with-travis-ci https://sites.google.com/site/transjoomla/transifex-tutorials/start-local-project https://wiki.dolibarr.org/index.php/Translator_documentation

versioning

we use the semantic versioning for this app: https://docs.npmjs.com/getting-started/semantic-versioning http://nodesource.com/blog/semver-a-primer/

                       Major   Patch   Metadata
                          \     /         /
Semantic Version:         1.2.3-beta.1+meta
                            /      \
                         Minor   (Pre)release