DEveloper COmpanion for Documented and annotatEd code Reference
The DECODER project has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No 824231.
Use-case C: 'MyThaiStar' - Extraction and
verification of 'Application Design
Documentation' (Industry Standard)
[MiguelJaén,Capgemini]
DECODER
Valencia,11-07-2019
2019 DEveloper COmpanion for Documented and annotatEd code Reference
1. Use case description
2. Use case documentation
3. Live demo


Index
2019 DEveloper COmpanion for Documented and annotatEd code Reference
Use	Case
Documentation	
generation
“Ideal”	Industry	Standard		
Documentation	Set
Generated	
Documentation	Set
My-Thai-StarModifies		
and		
enhances
Feeds	into
Generates
Provides	info	to	change	and	enhance
Decoder	partners
Modifies		
and		
enhances
Is	compared	to
2019 DEveloper COmpanion for Documented and annotatEd code Reference
Continuously running at http://de-mucdevondepl01:8090/ (inside Capgemini network)
My Thai Star
2019 DEveloper COmpanion for Documented and annotatEd code Reference
My Thai Star
Main reasons
Real sample case based on a real design.
Best development practices for different technologies.
Backend implementation interchangeable for the same Angular frontend app.
CI/CD complete sample.
Open source.
Ready to be cloned and run!
Devonfw complete reference sample for our frontend and backend technologies.
2019 DEveloper COmpanion for Documented and annotatEd code Reference
devon4ng
• Angular 8
• Angular Material UI
Framework
• Teradata Covalent UI
Framework
• i18n
• PWA
• Electron integrated
• Headless testing for CI/
CD
devon4j
• Spring Boot 2.1
integrated
• Spring Data integration
• New pagination and
search system
devon4net
• .NET Core 2.1.X
• Full components
customization by config
file
• Docker ready
• Port specification by
configuration
• Dependency injection by
Microsoft .NET Core
• Automapper support
• Entity framework ORM
• .NET Standard library 2.0
ready
devon4node
• TypeScript 3.3
• Based on Nest framework
• Aligned with devon4j
• Complete backend
implementation
• TypeORM integrated with
SQLite database
configuration
• Webpack bundler
• Nodemon runner
• Jest unit tests
Main technologies
2019 DEveloper COmpanion for Documented and annotatEd code Reference
Open source
• Source repository at https://github.com/devonfw/my-thai-star
2019 DEveloper COmpanion for Documented and annotatEd code Reference
▪ 66 forks
▪ 31 contributors
▪ 150 pull requests closed
▪ 1163 commits
▪ 10 localizations and languages at frontend
▪ OpenAPI specification with Swagger
▪ 3 main backend implementations:
• Java
• .NET
• Node.js
▪ 2 main frontend implementations
• Angular
‒ SPA web application
‒ Desktop app with Electron
‒ Ionic hybrid mobile app about to be released
• Xamarin
▪ E2E Testing project included
• Mr.Checker framework based on Selenium
• Example cases for end-to-end test
• Production line configuration
▪ CI/CD configuration
• Integration with Production Line
• Jenkinsfiles included
• Dockerfiles included
• Docker compose files included
Interesting remarks
2019 DEveloper COmpanion for Documented and annotatEd code Reference
Documentation: Wiki page
Wiki with more than 30 pages of info.
Oriented to teaching and reference
purposes.
Planned work to specify and adapt
this to a simpler format.
2019 DEveloper COmpanion for Documented and annotatEd code Reference
Documentation: source code
Standard Javadoc comments.
Explanatory comments.
JML annotations (pre-conditions/post-conditions) to be
added.
2019 DEveloper COmpanion for Documented and annotatEd code Reference
Documentation: user stories
Some commits are linked to user
stories, some others do not.
Partially structured natural language,
base of the ASD.
2019 DEveloper COmpanion for Documented and annotatEd code Reference
Industry Standard Application Specification and Design
2019 DEveloper COmpanion for Documented and annotatEd code Reference
Industry Standard Application Specification and Design
2019 DEveloper COmpanion for Documented and annotatEd code Reference
Industry Standard Application Specification and Design
2019 DEveloper COmpanion for Documented and annotatEd code Reference
Live demo
2019 DEveloper COmpanion for Documented and annotatEd code Reference
Thank You!
The DECODER project has received funding from the European Union’s Horizon 2020 research and innovation programme under
grant agreement number 824231.
If you need further information, please contact the coordinator: TECHNIKON Forschungs- und Planungsgesellschaft mbH, Burgplatz
3a, 9500 Villach, AUSTRIA, Tel: +43 4242 233 55, Fax: +43 4242 233 55 77, E-Mail: coordination@DECODER.eu
The information in this document is provided “as is”, and no guarantee or warranty is given that the information is fit for any particular purpose. The content of
this document reflects only the author`s view – the European Commission is not responsible for any use that may be made of the information it contains. The
users use the information at their sole risk and liability.

DECODER MyThaiStar Use Case

  • 1.
    DEveloper COmpanion forDocumented and annotatEd code Reference The DECODER project has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No 824231. Use-case C: 'MyThaiStar' - Extraction and verification of 'Application Design Documentation' (Industry Standard) [MiguelJaén,Capgemini] DECODER Valencia,11-07-2019
  • 2.
    2019 DEveloper COmpanionfor Documented and annotatEd code Reference 1. Use case description 2. Use case documentation 3. Live demo 
 Index
  • 3.
    2019 DEveloper COmpanionfor Documented and annotatEd code Reference Use Case Documentation generation “Ideal” Industry Standard Documentation Set Generated Documentation Set My-Thai-StarModifies and enhances Feeds into Generates Provides info to change and enhance Decoder partners Modifies and enhances Is compared to
  • 4.
    2019 DEveloper COmpanionfor Documented and annotatEd code Reference Continuously running at http://de-mucdevondepl01:8090/ (inside Capgemini network) My Thai Star
  • 5.
    2019 DEveloper COmpanionfor Documented and annotatEd code Reference My Thai Star Main reasons Real sample case based on a real design. Best development practices for different technologies. Backend implementation interchangeable for the same Angular frontend app. CI/CD complete sample. Open source. Ready to be cloned and run! Devonfw complete reference sample for our frontend and backend technologies.
  • 6.
    2019 DEveloper COmpanionfor Documented and annotatEd code Reference devon4ng • Angular 8 • Angular Material UI Framework • Teradata Covalent UI Framework • i18n • PWA • Electron integrated • Headless testing for CI/ CD devon4j • Spring Boot 2.1 integrated • Spring Data integration • New pagination and search system devon4net • .NET Core 2.1.X • Full components customization by config file • Docker ready • Port specification by configuration • Dependency injection by Microsoft .NET Core • Automapper support • Entity framework ORM • .NET Standard library 2.0 ready devon4node • TypeScript 3.3 • Based on Nest framework • Aligned with devon4j • Complete backend implementation • TypeORM integrated with SQLite database configuration • Webpack bundler • Nodemon runner • Jest unit tests Main technologies
  • 7.
    2019 DEveloper COmpanionfor Documented and annotatEd code Reference Open source • Source repository at https://github.com/devonfw/my-thai-star
  • 8.
    2019 DEveloper COmpanionfor Documented and annotatEd code Reference ▪ 66 forks ▪ 31 contributors ▪ 150 pull requests closed ▪ 1163 commits ▪ 10 localizations and languages at frontend ▪ OpenAPI specification with Swagger ▪ 3 main backend implementations: • Java • .NET • Node.js ▪ 2 main frontend implementations • Angular ‒ SPA web application ‒ Desktop app with Electron ‒ Ionic hybrid mobile app about to be released • Xamarin ▪ E2E Testing project included • Mr.Checker framework based on Selenium • Example cases for end-to-end test • Production line configuration ▪ CI/CD configuration • Integration with Production Line • Jenkinsfiles included • Dockerfiles included • Docker compose files included Interesting remarks
  • 9.
    2019 DEveloper COmpanionfor Documented and annotatEd code Reference Documentation: Wiki page Wiki with more than 30 pages of info. Oriented to teaching and reference purposes. Planned work to specify and adapt this to a simpler format.
  • 10.
    2019 DEveloper COmpanionfor Documented and annotatEd code Reference Documentation: source code Standard Javadoc comments. Explanatory comments. JML annotations (pre-conditions/post-conditions) to be added.
  • 11.
    2019 DEveloper COmpanionfor Documented and annotatEd code Reference Documentation: user stories Some commits are linked to user stories, some others do not. Partially structured natural language, base of the ASD.
  • 12.
    2019 DEveloper COmpanionfor Documented and annotatEd code Reference Industry Standard Application Specification and Design
  • 13.
    2019 DEveloper COmpanionfor Documented and annotatEd code Reference Industry Standard Application Specification and Design
  • 14.
    2019 DEveloper COmpanionfor Documented and annotatEd code Reference Industry Standard Application Specification and Design
  • 15.
    2019 DEveloper COmpanionfor Documented and annotatEd code Reference Live demo
  • 16.
    2019 DEveloper COmpanionfor Documented and annotatEd code Reference Thank You! The DECODER project has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement number 824231. If you need further information, please contact the coordinator: TECHNIKON Forschungs- und Planungsgesellschaft mbH, Burgplatz 3a, 9500 Villach, AUSTRIA, Tel: +43 4242 233 55, Fax: +43 4242 233 55 77, E-Mail: coordination@DECODER.eu The information in this document is provided “as is”, and no guarantee or warranty is given that the information is fit for any particular purpose. The content of this document reflects only the author`s view – the European Commission is not responsible for any use that may be made of the information it contains. The users use the information at their sole risk and liability.