Skip to content

Latest commit

 

History

History
88 lines (50 loc) · 2.98 KB

README.md

File metadata and controls

88 lines (50 loc) · 2.98 KB

ResumeFX (JavaFX Webview of jsonresume files)

License: GPL v3 Build Status Quality Gate Status

ResumeFX renders a JavaFX view of .json file that follows jsonresume.org standard and has the necessary configuration to be embedded in the web browser thanks to JPro.

You can view a production example with my own resume here: https://cv.tangorabox.com

The architecture style follows MVVM with minimal and very clean code thanks to the help of my own JavaFX micro-framework library.

JSON file loading and validation have been delegated to a third-party library to speed up development.

For the graphic icons, I have used FontAwesomeFX library.

In the test folder, I wrote some classes to prototype each component, and I have used CSSFX and my own Component-Inspector to speed up CSS style prototyping.


Features

  • Run on desktop and web browser (mvn jpro:run)

  • Responsive layout

  • Mobile layout

  • Double spaces on summary fields will be replaced with line breaks

  • Dockerfile, docker-compose-yml and .gitlab-ci.yml CI/CD example files

  • JSON file can be loaded externally to allow file edition without redeploy the project (see docker-compose.yml)


Usage

Java 11 or higher is required.

  • To launch as desktop mode, simply run ResumeFXLauncher class.
  • To launch as web-browser mode, execute mvn jpro:run

JSON file Limitations

  • Some fields must be numeric (eg: skill level handles a maximum value of 5)
  • Date fields must be in YYYY-MM-DD pattern
  • Picture field must be a valid and accessible url

Contributing

If you want to contribute to upgrade this project with new features or fixing bugs, you're welcome, please make a pull request.


Team

GaRzY
GaRzY
github.com/garzy

Support

Reach out to me at one of the following places!


License

License: GPL v3