diff --git a/.gitignore b/.gitignore index 3fc21ca..1d8df96 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,13 @@ test/temp bower_components .tmp test/bower_components/ + +# Dart files +pubspec.lock +packages/ +.pub/ +.packages +app/scripts/MorseConverter.js* + +# Atom editor +.atom/ diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..496191e --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,19 @@ +# Version 0.3.1 (01 June 2016) + +- Updated Bower dependencies +- Ripple effect on drawer items + +# Version 0.3.0 (30 May 2016) + +- Convert engine completly rewritten in Dart + - More efficient on larger texts + - Unit tests + +# Version 0.2.0 + +- All features also available in the Android and desktop app +- Complete rewrite with Polymer + +# Version 0.1.0 + +- Initial release diff --git a/README.md b/README.md index 2a49304..f278526 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,32 @@ -# [Morse Converter (web)](https://marcel-kapfer.de/writtenmorse/morseconverter) +# [Morse Converter (web)](https://mmk2410.org//morseconverter) -**This is a beta version. It may contains bugs** - -This is a Morse and [writtenMorse](https://marcel-kapfer.de/writtenmorse) converter for the web. With mobile-first in mind I tried to create a beautiful converting experience. The webapp comes with [Material design](https://google.com/design) and with enhanced features (like instant converting) to simplify the converting time. +This is a Morse and [writtenMorse](https://gitlab.com/mmk2410/writtenmorse-specs/wikis/Home) converter for the web. With mobile-first in mind I tried to create a beautiful converting experience. The webapp is designed following the [Material design](https://material.io/) specifications and with enhanced features (like instant converting) to simplify the converting time. ## Use it -The webapp can be accessed at [marcel-kapfer.de/writtenmorse/morseconverter](https://marcel-kapfer.de/writtenmorse/morseconverter). +The webapp is accessible at [mmk2410.org/morseconverter](https://mmk2410.org//morseconverter). ## Contribute 1. Fork it 2. Create your feature branch (`git checkout -b my-new-feature`) -3. Commit your changes (`git commit -am 'Add some feature'`) -4. Push to the branch (`git push origin my-new-feature`) -5. Create New Pull Request +3. Write your code and the tests for it. +4. Check if the code passes the tests. (`pub run test`). A code which does not passes the tests will not merged. +5. Commit your changes (`git commit -am 'Add some feature'`) +6. Push to the branch (`git push origin my-new-feature`) +7. Create new merge request + +## Technologies + +* Polymer and JavaScript for the front end. +* Dart for the converting engine. ## Build You need the following programs installed on your computer: ``` -npm, bower, gulp +npm, bower, gulp, dart2js ``` To see your changes run the first time: @@ -30,10 +35,20 @@ To see your changes run the first time: npm install && bower install ``` -and the rebuild the webapp with: +Now change to `app/scripts/` and compile the `MorseConverter.dart`: + +``` +dart2js -m MorseConverter.dart -o MorseConverter.js +``` + +and then rebuild the webapp with: ``` gulp ``` -The webapp is accessible in the `dist/` directory +The webapp is accessible in the `dist/` directory. A development server can be started with + +``` +gulp serve +``` diff --git a/app/elements/app-theme.html b/app/elements/app-theme.html index 63b0d6c..199745c 100644 --- a/app/elements/app-theme.html +++ b/app/elements/app-theme.html @@ -1,3 +1,7 @@ +