Skip to content
This repository has been archived by the owner on Aug 18, 2020. It is now read-only.
/ KarumiCodeTest Public archive

A code test which Karumi people have asked me to build as a part of it's hiring process.

License

Notifications You must be signed in to change notification settings

seniorglez/KarumiCodeTest

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

KarumiCodeTest

A simple javaFX app with a full logging system which mockes the network connections.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

As long the target of this project is only desktop runing on the jvm we only need to use maven to work with it. You can check how to intall maven on your OS directly on the maven documentation.

How to compile and run the project

To run a JavaFX projet like this with out the help of a build automation tool you will need to pass the module path and the modules that you are using as VM options. We are working with maven so the most convinient way to work with javaFX is through the javafx-maven-plugin which handles all these options for us. This also allows us to have a better integration with owrs IDEs.

You can compile the project using the maven compiler plugin:

mvn compile

Or the javafx-maven-plugin:

mvn javafx:compile

The compiling commands are optional because when you run the project through the javafx-maven-plugin it will compile the project before it try to run it.

To run the project on your local JVM:

mvn javafx:run

We are working with java11 on a modular project so you can build a Jlink too. We are using the javafx-maven-plugin to build it too:

mvn javafx:jlink

Next steps

This project is configured based on my needs, if your want to go further with it let me give you some advices.

Of course all the plugins I used are fully configurable even if the default configuration is enough for what I have done here. So, I recomend you to read the plugins documentation if you are thinking about making somethink bigger.

Native Images

A native image is a feature of GraalVM that allow you to compile java code to a standalone executable. With this tool you can make executables for Windows, Linux and MacOS and even for iOS and Android. To get this done on the easy way I recomend you to use client-maven-plugin. You can find all the information you need about the plugin on its repository but if you prefer to check a project that uses this plugin you can check this project of mine.

Built With

  • Maven - The build automation tool
  • OpenJavaFX - An open source, next generation client application platform for desktop, mobile and embedded systems built on Java.
  • javafx-maven-plugin - The javaFX plugin which allows to compile and run javaFX 11 or higher projets.

Contributing

As long this is a personal test I am not acepting any pull request, I hope you understand. But, anyway you can still fork it. If you do, please let me know 😜.

Authors

  • Diego Dominguez Twitter: DGlez1111

License

The MIT License (MIT)

Copyright (c) 2020 Diego Dominguez Gonzalez

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

A code test which Karumi people have asked me to build as a part of it's hiring process.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Languages