appreciated/quick-start-base

Allows you to decouple your design from your application logic.

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.appreciated:quick-start-base:0.9.20'
	}
	dependencies {
		implementation("com.github.appreciated:quick-start-base:0.9.20")
	}
	<dependency>
	    <groupId>com.github.appreciated</groupId>
	    <artifactId>quick-start-base</artifactId>
	    <version>0.9.20</version>
	</dependency>

                            
    libraryDependencies += "com.github.appreciated" % "quick-start-base" % "0.9.20"
        
        

                            
    :dependencies [[com.github.appreciated/quick-start-base "0.9.20"]]

Readme

quick-start-base Codacy Badge Coverage Status

This Project is still under construction! You can already use it for Experiments but be ready for extensive API changes even in minor versions.

Description

Plain Vaadin applications do not have normal web page navigation as they usually run on a single page, as all Ajax applications do. (https://vaadin.com/docs/-/part/framework/advanced/advanced-navigator.html)

This Library is for Webapplications which aim to look like modern Websites with Navigation.
It comes with a component which allows to archive something similar to the Vaadin Navigator Component (https://vaadin.com/docs/-/part/framework/advanced/advanced-navigator.html).

The purpose is to create faster Applications which require one or multiple of the following functionalities:

  • Multipage Website
  • Seperate apperance for mobile and desktop
  • Login (and Registration)
  • Seperate Login Page or on Menubar
  • (TODO) Access Management (A basic example is given which you can ofcourse replace by your own code)
  • (TODO) HTML5 History API

The Library won't do any database "stuff" you will still need to write the data back to the database.

Antoher Advantage of this Library due to a loose coupling of design and your application logic the look of your application can be changed very easily by just switching the "Design". If the given Designs are not sufficent just fork one and fit them to your needs, you might even consider to give me a link then I can list them here.

This Library offers a API for the Designs which then decide on their own how to represent the data you give them on instanciation. Also this Library comes with some basic functionality for the navigation (might be replaced by the Navigator).

Currently available Designs:

Additionally this Library comes with:

  • component printing (This function is limited to the visible html)
  • simplyfied (but more abstracted) Dialog (Window) Creation (with Negative / Postive Buttons)
  • component pager (Might be replaced by https://vaadin.com/directory#!addon/carousel, because it offers swiping)
  • progress stepper
  • abstracted versions of Upload and Download