Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prismicio-community/scala-kit
Development kit for the Scala language
https://github.com/prismicio-community/scala-kit
Last synced: about 1 month ago
JSON representation
Development kit for the Scala language
- Host: GitHub
- URL: https://github.com/prismicio-community/scala-kit
- Owner: prismicio-community
- Created: 2013-08-01T10:11:11.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2020-04-15T16:39:43.000Z (over 4 years ago)
- Last Synced: 2024-11-11T03:33:20.498Z (about 2 months ago)
- Language: Scala
- Homepage:
- Size: 8.36 MB
- Stars: 19
- Watchers: 18
- Forks: 26
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-prismic - scala-kit - Scala kit. (Ecosystem / Development Kits)
README
## Scala development kit for prismic.io
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.prismic/scala-kit_2.11/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.prismic/scala-kit_2.11)
[![Build Status](https://api.travis-ci.org/prismicio/scala-kit.png)](https://travis-ci.org/prismicio/scala-kit)### Getting started
#### Install the kit for your project with Maven
You can find this library in our own Maven repository (hosted on Github).
Then add, the library dependency:
```
"io.prismic" %% "scala-kit" % "2.4.2"
```* *the kit requires **JDK 7** or above*
* *you may need to adapt the version number*#### Get started with prismic.io
You can find out [how to get started with prismic.io](https://developers.prismic.io/documentation/UjBaQsuvzdIHvE4D/getting-started) on our [prismic.io developer's portal](https://developers.prismic.io/).
#### Get started using the kit
Also on our [prismic.io developer's portal](https://developers.prismic.io/), on top of our full documentation, you will:
* get a thorough introduction of [how to use prismic.io kits](https://developers.prismic.io/documentation/UjBe8bGIJ3EKtgBZ/api-documentation#kits-and-helpers), including this one.
* see [what else is available for Scala](https://developers.prismic.io/technologies/UjBh4cuvzeMJvE4k/scala): starter projects, examples, ...#### Kit's detailed documentation
You can find [the documentation of the Scala kit as a Scaladoc](http://prismicio.github.io/scala-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/scala-kit/releases).
### Contribute to the kit
Contribution is open to all developer levels, read our "[Contribute to the official kits](https://developers.prismic.io/documentation/UszOeAEAANUlwFpp/contribute-to-the-official-kits)" documentation to learn more.
#### Install the kit locally
Fork and clone the repository, and run `sbt compile` from the newly-created directory ([install sbt](http://www.scala-sbt.org/release/docs/Getting-Started/Setup.html) first if you haven't)
#### Test
Please write tests for any bugfix or new feature.
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.
#### Documentation
Please document any bugfix or new feature.
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 Scaladoc
(Prismic.io developers only)
sbt ghpages-push-site
### 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.