https://github.com/marvin-we/steem-java-api-wrapper
An API Wrapper for Steem written in Java
https://github.com/marvin-we/steem-java-api-wrapper
java-api-wrapper steem steemit steemj
Last synced: 23 days ago
JSON representation
An API Wrapper for Steem written in Java
- Host: GitHub
- URL: https://github.com/marvin-we/steem-java-api-wrapper
- Owner: marvin-we
- License: gpl-3.0
- Created: 2016-12-26T14:48:39.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-11-15T23:29:42.000Z (over 2 years ago)
- Last Synced: 2024-10-28T21:37:59.414Z (6 months ago)
- Topics: java-api-wrapper, steem, steemit, steemj
- Language: Java
- Size: 3.3 MB
- Stars: 68
- Watchers: 13
- Forks: 27
- Open Issues: 62
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-steem - SteemJ - An API Wrapper for Steem written in Java (SDKs)
README
This project allows you to easily access data stored in the Steem blockchain. The project has been initialized by dez1337 on steemit.com.
#### The latest 0.4.x STABLE can be obtained via jitpack.io:
[](https://jitpack.io/#marvin-we/steem-java-api-wrapper/0.4.6-20180926-01PRE/steemj-core)
Example below is for latest 0.4.x. Visit https://jitpack.io/#marvin-we/steem-java-api-wrapper/0.4.6-20180926-01PRE/steemj-core to get a list of available builds.
## Gradle
```Gradle
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
dependencies {
compile 'com.github.marvin-we.steem-java-api-wrapper:steemj-core:0.4.x-SNAPSHOT'
}
```
## Maven
File: pom.xml
```Xml
jitpack.io
https://jitpack.io
...
com.github.marvin-we.steem-java-api-wrapper
steemj-core
0.4.x-SNAPSHOT
```
# Full Documentation
- Please have a look at the [Wiki](https://github.com/marvin-we/steem-java-api-wrapper/wiki) for full documentation, examples, operational details and other information.
- Or have a look at the JavaDoc.
# Communication
- Please contact me at the [Discord Java Channel](https://discord.gg/fsJjr3Q)
- Or directly on [Steemit.com](https://steemit.com/@dez1337)
- Beside that you can also create an [Issue](https://github.com/marvin-we/steem-java-api-wrapper/issues) here at GitHub.
# Contributors
- [philip-healy](https://github.com/philip-healy) took care of the "simplified operations".
- [ray66rus](https://steemit.com/@ray66rus) is testing SteemJ for Android and provided a lot of improvements.
- [inertia](https://steemit.com/@inertia) provided a bunch of unit tests to this project.
- An article from [Kyle](https://steemit.com/@klye) has been used to improve the documentation of the methods.
- The [guide](https://steemit.com/steem/@xeroc/steem-transaction-signing-in-a-nutshell) from [xeroc](https://steemit.com/@xeroc) shows how to create and sign transactions.
# Binaries
SteemJ binaries are pushed into the maven central repository and can be integrated with a bunch of build management tools like Maven.
Please have a look at the [Wiki](https://github.com/marvin-we/steem-java-api-wrapper/wiki/How-to-add-SteemJ-to-your-project) to find examples for Maven, Ivy, Gradle and others.
# How to build the project
The project requires Maven and Java to be installed on your machine. It can be build with the default maven command:
>mvn clean package
The resulting JAR can be found in the target directory as usual. Please notice that some integration tests require different private keys. Please provide them as -D parameter or use the properties file ( *src/test/resources/accountDetailsUsedDuringTests.properties* ) to define them. If you do not want to execute tests at all add *"-Dmaven.test.skip"* to the mvn call which skips the test execution during the build.
# Bugs and Feedback
For bugs or feature requests please create a [GitHub Issue](https://github.com/marvin-we/steem-java-api-wrapper/issues).
For general discussions or questions you can also:
* Post your questions in the [Discord Java Channel](https://discord.gg/9jZQHv)
* Reply to one of the SteemJ update posts on [Steemit.com](https://steemit.com/@dez1337)
* Contact me on [steemit.chat](https://steemit.chat/channel/dev)
# Example
The [sample module](https://github.com/marvin-we/steem-java-api-wrapper/tree/master/sample) of the SteemJ project provides showcases for the most common acitivies and operations users want to perform.
Beside that you can find a lot of snippets and examples in the different [Wiki sections](https://github.com/marvin-we/steem-java-api-wrapper/wiki).