/spring-mobile

Extensions to Spring MVC for developing mobile web applications.

Primary LanguageJavaApache License 2.0Apache-2.0

Spring Mobile

"Build Status"

Spring Mobile is an extension of the Spring Framework and Spring Web MVC that aims to simplify the development of mobile web applications.

Features

  • A device resolver abstraction for server-side detection of mobile and tablet devices

  • Site preference management that allows the user to indicate if he or she prefers a "normal", "mobile", or "tablet" experience

  • A site switcher capable of switching the user to the most appropriate site, either mobile, tablet, or normal, based on his or her device and optionally indicated site preference

  • Device aware view management for organizing and managing different views for specific devices

Download Artifacts

Include the spring-mobile-starter in your Spring Boot application to enable Spring Mobile's Auto-Configuration. See downloading Spring artifacts for Maven repository information. Unable to use Maven or other transitive dependency management tools? See building a distribution with dependencies.

Gradle

dependencies {
    compile("org.springframework.mobile:spring-mobile-starter:2.0.0.M2")
}
repositories {
    maven { url "https://repo.spring.io/milestone" }
}

Maven

<dependencies>
    <dependency>
        <groupId>org.springframework.mobile</groupId>
        <artifactId>spring-mobile-starter</artifactId>
        <version>2.0.0.M2</version>
    </dependency>
</dependencies>

<repositories>
    <repository>
        <id>spring-milestones</id>
        <name>Spring Milestones</name>
        <url>https://repo.spring.io/milestone</url>
    </repository>
</repositories>

Documentation

See the current Javadoc and reference docs.

Sample Applications

Several example projects are available in the samples repository.

Getting Started Guides

The spring.io web site contains many getting started guides that cover a broad range of topics.

Support

Review the spring-mobile tag on Stack Overflow.

Issue Tracking

Report issues via GitHub issues. Understand our issue management process by reading about the lifecycle of an issue.

Build from Source

  1. Clone the repository from GitHub:

    $ git clone https://github.com/spring-projects/spring-mobile.git
  2. Navigate into the cloned repository directory:

    $ cd spring-mobile
  3. The project uses Gradle to build:

    $ ./gradlew build
  4. Install jars into your local Maven cache (optional)

    $ ./gradlew install

Import Source into your IDE

Eclipse

  1. To generate Eclipse metadata (.classpath and .project files):

    $ ./gradlew eclipse
  2. Once complete, you may then import the projects into Eclipse as usual:

    File -> Import -> Existing projects into workspace
    

Note: Spring Tool Suite has built in support for Gradle, and you can simply import as Gradle projects.

IDEA

Generate IDEA metadata (.iml and .ipr files):

$ ./gradlew idea

Contribute

Pull requests are welcome. See the contributor guidelines for details.

Stay in Touch

Follow @SpringCentral as well as @SpringFramework on Twitter. In-depth articles can be found at The Spring Blog, and releases are announced via our news feed.

License

Spring Mobile is released under version 2.0 of the Apache License.