https://github.com/nomisrev/arrowdokkatest
Testing dokka jekyll website output
https://github.com/nomisrev/arrowdokkatest
Last synced: 11 months ago
JSON representation
Testing dokka jekyll website output
- Host: GitHub
- URL: https://github.com/nomisrev/arrowdokkatest
- Owner: nomisRev
- License: other
- Created: 2021-11-18T20:31:20.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-11-18T21:12:25.000Z (over 4 years ago)
- Last Synced: 2025-01-31T07:41:38.735Z (over 1 year ago)
- Language: Kotlin
- Size: 5.27 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://maven-badges.herokuapp.com/maven-central/io.arrow-kt/arrow-core)
[](https://oss.sonatype.org/service/local/repositories/snapshots/content/io/arrow-kt/)
[](https://kotlinlang.org/docs/reference/whatsnew14.html)
[](https://www.apache.org/licenses/LICENSE-2.0)
[](https://stackoverflow.com/questions/tagged/arrow-kt)
[](https://twitter.com/arrow_kt)
Λrrow is a library for Typed Functional Programming in Kotlin.
Arrow aims to provide a [*lingua franca*](https://en.wikipedia.org/wiki/Lingua_franca) of interfaces
and abstractions across Kotlin libraries. For this, it includes the most popular data types such
as `Option`, `Either`, `Validated` etc and functional operators such as `traverse` and computation
blocks to empower users to write pure FP apps and libraries built atop higher order abstractions.
Use the list below to learn more about Λrrow's main features.
- [Documentation](http://arrow-kt.io)
- [Type classes](http://arrow-kt.io/docs/typeclasses/intro/): defining behaviors for data
- [Effects](http://arrow-kt.io/docs/effects/io/): interfacing with external systems
- [Optics](http://arrow-kt.io/docs/optics/iso/): inspecting and modifying data structures
#### Curated external links
- [Media: blogs, presentations, etc.](https://media.arrow-kt.io)
If you have a blog post, talk, or upcoming event on Arrow, please considering opening an issue or PR
to add to the collection over at the [Arrow Media](https://github.com/arrow-kt/arrow-media) repo.
## Join Us
Arrow is an inclusive community powered by awesome individuals like you. As an actively growing
ecosystem, Arrow and its associated libraries and toolsets are in need of new contributors! We have
issues suited for all levels, from entry to advanced, and our maintainers are happy to provide 1:1
mentoring. All are welcome in Arrow.
If you’re looking to contribute, have questions, or want to keep up-to-date about what’s happening,
please follow us here and say hello!
- [Arrow on Twitter](https://twitter.com/arrow_kt)
- [#arrow on Kotlin Slack](https://kotlinlang.slack.com/messages/C5UPMM0A0)
- [#arrow-contributors on Kotlin Slack](https://kotlinlang.slack.com/archives/C8UK6RTHU)
- [Arrow on Gitter](https://gitter.im/arrow-kt/Lobby)
Find more details in [CONTRIBUTING](CONTRIBUTING.md).
## Setup
### JDK
Make sure to have the latest version of JDK 1.8 (or higher) installed.
JDK 16 doesn't currently work but will do once we upgrade
to [Gradle 7.0](https://github.com/arrow-kt/arrow/issues/2442)
### Android
Arrow supports Android starting on API 21 and up.
### Gradle
#### Basic Setup
In your project's root `build.gradle`, append this repository to your list:
```groovy
allprojects {
repositories {
mavenCentral()
}
}
```
Add the dependencies into the project's `build.gradle`:
##### Λrrow Core
```groovy
def arrow_version = "1.0.1"
dependencies {
implementation "io.arrow-kt:arrow-core:$arrow_version"
}
```
##### Λrrow Core + Λrrow Optics
```groovy
apply plugin: 'kotlin-kapt'
def arrow_version = "1.0.1"
dependencies {
implementation "io.arrow-kt:arrow-optics:$arrow_version"
kapt "io.arrow-kt:arrow-meta:$arrow_version"
}
```
##### Λrrow Core + Λrrow Fx
```groovy
def arrow_version = "1.0.1"
dependencies {
implementation "io.arrow-kt:arrow-fx-coroutines:$arrow_version"
}
```
#### BOM file
To avoid specifying the Arrow version for every dependency, a BOM file is available:
```
implementation platform("io.arrow-kt:arrow-stack:$arrow_version")
implementation "io.arrow-kt:arrow-core"
implementation "io.arrow-kt:arrow-fx-coroutines"
...
```
### Maven
#### Basic Setup
Make sure to have at least the latest version of JDK 1.8 installed. Add to your `pom.xml` file the
following properties:
```xml
1.5.31
1.0.1
```
Add the dependencies that you want to use:
```xml
io.arrow-kt
arrow-core
${arrow.version}
```
#### Enabling kapt for the Optics DSL
For the Optics DSL, enable annotation processing using Kotlin plugin:
```xml
org.jetbrains.kotlin
kotlin-maven-plugin
${kotlin.version}
kapt
kapt
src/main/kotlin
io.arrow-kt
arrow-meta
${arrow.version}
compile
compile
compile
src/main/kotlin
test-compile
test-compile
test-compile
```
#### BOM file
To avoid specifying the Arrow version for every dependency, a BOM file is available:
```
io.arrow-kt
arrow-stack
${arrow.version}
pom
import
...
```
## Next development version
If you want to try the latest features, replace `1.0.1` with `1.0.2-SNAPSHOT` and add this
repository:
```groovy
allprojects {
repositories {
...
maven { url "https://oss.sonatype.org/content/repositories/snapshots/" }
}
}
```
## License
Copyright (C) 2017 The Λrrow Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file 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.