isabella232 / java-springmvc-starter

Starter project for Java, Spring MVC – Works with any prismic.io repository

Starter for Spring MVC projects

This is a blank Spring MVC project that will connect to any prismic.io repository, and trivially list its documents. It uses the prismic.io Java developement kit, and provide a few helpers to integrate with the Spring framework.

Getting started

Launch the starter project

Assuming you've installed Maven, just run mvn jetty:run, and open your browser at http://localhost:8080/

Your Spring MVC starter project is now up and running! However, by default, it will list and display documents from our "Les Bonnes Choses" example repository.

Configure the starter project

Edit the web.xml file to make the application point to the correct repository in the prismic filter:

  <!--  Prismic.io -->
  <filter>
    <filter-name>prismicFilter</filter-name>
    <filter-class>io.prismic.servlet.PrismicFilter</filter-class>
    <init-param>
        <param-name>endpoint</param-name>
        <param-value>https://lesbonneschoses.prismic.io/api</param-value>
        <!-- param-name>accessToken</param-name>
        <param-value>xxxx</param-value -->
    </init-param>
  </filter>

To set up the Previews, go to the Applications panel in your repository's settings, and add a new preview site. For example to test locally, you can create a local site with http://localhost:8080/preview as the URL.

You may have to restart your Spring MVC server.

Get started with prismic.io

You can find out how to get started with prismic.io on our prismic.io developer's portal.

Understand the Java development kit

You'll find more information about how to use the development kit included in this starter project, by reading its README file.

Contribute to the starter project

Contribution is open to all developer levels, read our "Contribute to the official kits" documentation to learn more.

Licence

This software is licensed under the Apache 2 license, quoted below.

Copyright 2013 Zengularity (http://www.zengularity.com).

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this project except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.