https://github.com/prismicio-community/java-kit
Community maintained development kit for Prismic and the Java language
https://github.com/prismicio-community/java-kit
java
Last synced: 4 months ago
JSON representation
Community maintained development kit for Prismic and the Java language
- Host: GitHub
- URL: https://github.com/prismicio-community/java-kit
- Owner: prismicio-community
- Created: 2013-08-20T18:03:37.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-06-30T21:21:53.000Z (10 months ago)
- Last Synced: 2024-12-10T05:32:33.115Z (5 months ago)
- Topics: java
- Language: Java
- Homepage: https://prismic.io
- Size: 1.55 MB
- Stars: 15
- Watchers: 18
- Forks: 38
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-prismic - java-kit - Java kit. (Ecosystem / Development Kits)
README
## Java development kit for prismic.io
[](https://maven-badges.herokuapp.com/maven-central/io.prismic/java-kit)
[](https://travis-ci.org/prismicio/java-kit)
### Getting started
### Install the kit for your project through [Maven](http://maven.apache.org/)
This library is on Maven Central. The kit coordinates are:
```
io.prismic
java-kit
X.X.X
```
_(you may need to adapt the version number)_
The kit requires **Java 8** or superior.
#### Documentation
- [Prismic.io documentation](./docs)
- [Javadoc](http://prismicio.github.io/java-kit/)
### Changelog
Need to see what changed, or to upgrade your kit? We keep our changelog on [this repository's "Releases" tab](https://github.com/prismicio/java-kit/releases).
#### Install the kit locally
Run `./mvnw install`.
Always run `./mvnw test` before committing, to make sure everything runs as expected.
#### Test
Please write tests using [JUnit4](http://junit.org/junit4/) for any bugfix or new feature; please add the tests to the [AppTest.java file](https://github.com/prismicio/java-kit/blob/master/src/test/java/io/prismic/AppTest.java). Run `./mvnw test` to test.
If you find existing code that is not optimally tested and wish to make it better, we really appreciate it; but you should document it on its own branch and its own pull request.
#### Documenting
Please document any bugfix or new feature using the [Javadoc syntax](https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html)
If you find existing code that is not optimally documented and wish to make it better, we really appreciate it; but you should document it on its own branch and its own pull request.
#### Publish Javadoc
(Only for Prismic.io developers)
./mvnw clean javadoc:javadoc scm-publish:publish-scm
### Licence
This software is licensed under the Apache 2 license, quoted below.
Copyright 2018 Prismic.io (https://prismic.io).
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.