## Repositories

| Repository | Link |
|-----|-----|
| `steemconnect4j` |  https://github.com/hapramp/steemconnect4j |
| Example Project | https://github.com/hapramp/SteemConnectSampleApp |

---

# 1. About steemconnect4j

<center>
  <img src="https://ipfs.busy.org/ipfs/QmXVGoj2vx4ojo98kLXxVeUioeJUjsEpCcBdUGWSyn3PHB"/>
  <p>A Java SDK for SteemConnect v2</p>
</center>


## 1.1. Need for a SteemConnect Java SDK

[SteemConnect](https://v2.steemconnect.com/) has now become a standard for authentication in Steem based decentralized applications. A lot of popular Steem apps like @busy.org, @dtube, @dmania, etc. are now using SteemConnect for authenticating users.

Developing web apps using SteemConnect is simple, thanks to the [steemconnect-sdk for JS](https://github.com/steemit/steemconnect-sdk). But it is difficult to develop Java-based applications like [Android](https://developer.android.com/), [Jetty](http://www.eclipse.org/jetty/), etc. on the top of SteemConnect.

In order to make this process convenient, I developed this SDK which can be used by anyone to develop SteemConnect based Java apps.

## 1.2. Introduction

steemconnect4j is an SDK for using SteemConnect v2 (SC2) API in Java-based projects like Android, Jetty, etc. It provides simple methods to interact with the Steem blockchain using access token received from the SteemConnect API.

## 1.3. Current Features

As of now, steemconnect4j offers the following features -

- [Initialization using all possible parameters](https://github.com/hapramp/steemconnect4j#initialize-steemconnect)
- [Getting login URL](https://github.com/hapramp/steemconnect4j#getting-login-url)
- [Getting user profile](https://github.com/hapramp/steemconnect4j#getting-user-profile)
- [Voting on a post](https://github.com/hapramp/steemconnect4j#vote)
- [Replying to a post via comment](https://github.com/hapramp/steemconnect4j#comment)
- [Getting link to sign transactions](https://github.com/hapramp/steemconnect4j#generate-hot-signing-link)
- [Revoking Token/Logging out](https://github.com/hapramp/steemconnect4j#logout)
- [Reblogging](https://github.com/hapramp/steemconnect4j#reblog)
- [Follow/Unfollow](https://github.com/hapramp/steemconnect4j#follow)
- [Ignoring other user(s)](https://github.com/hapramp/steemconnect4j#ignore)
- [Claining rewards](https://github.com/hapramp/steemconnect4j#claim-reward-balance)
- [Updating user's metadata](https://github.com/hapramp/steemconnect4j#update-user-metadata)

---

# 2. Tech

# 2.1. Technologies Used

| Task | Tech/Tool | Link(s) |
|-----|-----|-----|
| Build Tool | [Gradle](https://gradle.org/) | [Root config](https://github.com/hapramp/steemconnect4j/blob/master/build.gradle) [steemconnect4j config](https://github.com/hapramp/steemconnect4j/blob/master/steemconnect4j/build.gradle) |
| Test Coverage | [Jacoco](https://www.eclemma.org/jacoco/) | [Config](https://github.com/hapramp/steemconnect4j/blob/master/steemconnect4j/build.gradle#L27-L29) |
| Linting | [Checkstyle](https://github.com/checkstyle/checkstyle) | [Config file](https://github.com/hapramp/steemconnect4j/blob/master/config/checkstyle/checkstyle.xml) |
| Package Repository | [JitPack](https://jitpack.io/) | [Repository](https://jitpack.io/#hapramp/steemconnect4j) |

# 2.2. Using with Gradle

In order to add the SDK to a Gradle based project, make sure that you have JitPack in repositories for your root config - 

![1.png](https://ipfs.busy.org/ipfs/QmQBEr9qXgMJwp5jAZXNmdUu8s6VnWH9xGzqv3mmJd9Ww4)

After this, just add `steemconnect4j` as project dependency and you are good to go - 

![2.png](https://ipfs.busy.org/ipfs/Qmc8uSLUeSNiMtN8pVeewb5puBZmCbiC9tgLLXmx3EfULL)

## 2.3. API Documentation

You can find all the documentation for the API in the project's [README file](https://github.com/hapramp/steemconnect4j/blob/master/README.md).

## 2.4. Testing, Coverage, and Linting using Travis CI

Travis CI is used to ensure that all the tests pass and a considerable amount of code is covered under tests. It uses hard checks on checkstyle so that even warnings turn into errors while CI build.

Here is what the Travis configuration looks like - 

![3.png](https://ipfs.busy.org/ipfs/QmXcCN4cvzCDQrKyZKDXse8rGkmiXGhAxFfm3Z4et9L1y5)

---

# 3. Example Implementation

To test the proper functioning of the SDK, I developed an Android application that authenticates a user and displays their information in the app.

## 3.1. Code and Repository

The application's source code is open source on Github - https://github.com/hapramp/SteemConnectSampleApp.

Minimum SDK version for the project is 17 and targetted SDK version is 27.

## 3.2. Demo

Enough talk! See it in action - 

<center>
  <img src="https://user-images.githubusercontent.com/10809719/41578179-93134d82-73ae-11e8-9ec4-763ee652f75d.gif" alt="Demo"/>
</center>

---

# 4. Future Plans

The SDK will be used in [HapRamp's Android app](https://github.com/hapramp/Hapramp-Android) for authentication and other actions like voting, commenting, etc. I aim to resolve all the bugs present in the SDK during this process.

I am also working on improving the test coverage for the code and wish to take it to decent numbers.

---

# 5. How to contribute?

The project is open to contributions in any way possible. If you find a bug, please open an issue in the project's [issue tracker](https://github.com/hapramp/steemconnect4j/issues/). For submitting code patches, feel free to open pull requests on Github.

## 5.1. Creating a Pull Request

Here's the basic flow for contributing to the project - 

1. Fork the project.
2. Clone your forked version of the project.
3. Checkout a new branch.
4. Make desired changes.
5. Commit your changes with a proper commit message.
6. Push your local branch.
7. Go to Github and create a pull request.
8. Done 🎉

## 5.2. Join the Conversation

If you wish to talk, please join HapRamp's Discord channel - https://discord.gg/r9vwcHe.

---

## Github Account

https://github.com/bxute

> Written by @bxute from @hapramp