Basilisk

:github-branch: development

image::src/media/banners/medium.png[Basilisk]

image:https://img.shields.io/travis/basilisk-fw/basilisk/{github-branch}.svg["Build Status (travis)", link="https://travis-ci.org/basilisk-fw/basilisk"] image:https://img.shields.io/coveralls/basilisk-fw/basilisk/{github-branch}.svg["Coverage Status (coveralls)", link="https://coveralls.io/r/basilisk-fw/basilisk"] image:https://img.shields.io/codecov/c/github/basilisk-fw/basilisk/{github-branch}.svg["Coverage Status (codecov)", link="https://codecov.io/github/basilisk-fw/basilisk"]

image:https://sonarcloud.io/api/badges/measure?key=org.kordamp.basilisk:basilisk&metric=sqale_debt_ratio["Technical Debt", link="https://sonarcloud.io/dashboard?id=org.kordamp.basilisk%3Abasilisk"] image:https://www.versioneye.com/user/projects/5998530a368b08000f3a7cf4/badge.svg["Dependency Status", link="https://www.versioneye.com/user/projects/5998530a368b08000f3a7cf4"]

image:https://img.shields.io/maven-central/v/org.kordamp.basilisk/basilisk-core.svg[Download, link="https://search.maven.org/#search|ga|1|basilisk-core"] image:https://api.bintray.com/packages/basilisk/basilisk/basilisk-core/images/download.svg[Download, link="https://bintray.com/basilisk/basilisk"]

image:https://img.shields.io/badge/license-ASF2-blue.svg["Apache License 2", link="http://www.apache.org/licenses/LICENSE-2.0.txt"] image:https://img.shields.io/maintenance/yes!/2017.svg[] image:https://img.shields.io/gitter/room/basilisk-fw/basilisk.svg[link="https://gitter.im/basilisk-fw/basilisk] image:https://img.shields.io/badge/donations-Patreon-f96854.svg[link="https://www.patreon.com/user?u=6609318"]

Basilisk is desktop/mobile application development platform for the JVM. Inspired by http://griffon-framework.org[Griffon], Basilisk leverages JavaFX and JavafXPorts to bring the same codebase to desktop and mobile platforms alike.

Griffon developers should feel right at home when trying out Basilisk. Many of Griffon's features and commands are shared with Basilisk.

Seasoned Java developers will also be able to pick up the pace quickly, as the framework relieves you of the burden of maintaining an application structure, allowing you to concentrate on getting the code right.

== Quickstart

The recommended way to get started with a Basilisk project is to use a Lazybones project template and Gradle. You can install these tools with SDKMAN.

$ curl -s http://get.sdkman.io | bash
$ sdk install lazybones
$ sdk install gradle

Next register the basilisk-lazybones-templates repository with Lazybones' config file. Edit $USER_HOME/.lazybones/config.groovy

bintrayRepositories = [
    "basilisk/basilisk-lazybones-templates",
    "pledbrook/lazybones-templates"
]

List all available templates by invoking the following command

$ lazybones list
Available templates in basilisk/basilisk-lazybones-templates

    basilisk-application
    basilisk-plugin

Select a starting template from the list and invoke the create command

$ lazybones create basilisk-application sample

Compile, run and test the project with any of these commands

$ gradle build
$ gradle test
$ gradle run
$ gradle launchIPhoneSimulator

== Links

• https://github.com/basilisk-fw/basilisk[Home]
• https://github.com/basilisk-fw/basilisk[Documentation]
• https://github.com/basilisk-fw/basilisk[Source]
• https://github.com/basilisk-fw/basilisk/issues[Issue Tracker]
• http://basilisk-user.1128066.n5.nabble.com/[Mailing Lists]