Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/parse-community/Parse-SDK-Android
The Android SDK for Parse Platform
https://github.com/parse-community/Parse-SDK-Android
android hacktoberfest parse parse-android parse-platform sdk
Last synced: 3 months ago
JSON representation
The Android SDK for Parse Platform
- Host: GitHub
- URL: https://github.com/parse-community/Parse-SDK-Android
- Owner: parse-community
- License: other
- Created: 2015-08-12T22:57:48.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-06-11T10:21:40.000Z (5 months ago)
- Last Synced: 2024-07-30T15:18:00.764Z (3 months ago)
- Topics: android, hacktoberfest, parse, parse-android, parse-platform, sdk
- Language: Java
- Homepage: https://parseplatform.org/
- Size: 4.22 MB
- Stars: 1,879
- Watchers: 107
- Forks: 739
- Open Issues: 128
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
---
[](https://github.com/parse-community/Parse-SDK-Android/actions?query=workflow%3Aci+branch%3Amaster)
[](https://snyk.io/test/github/parse-community/Parse-SDK-Android)
[](https://codecov.io/gh/parse-community/Parse-SDK-Android)
[](https://github.com/parse-community/parse-dashboard/releases)
[](https://github.com/parse-community/parse-dashboard/releases)
[](https://jitpack.io/#parse-community/Parse-SDK-Android)
[](https://jitpack.io/#parse-community/Parse-SDK-Android)
[][open-collective-link]
[][open-collective-link]
[](https://github.com/parse-community/Parse-SDK-Android/blob/master/LICENSE)
[](https://community.parseplatform.org/c/parse-server)
[](https://twitter.com/intent/follow?screen_name=ParsePlatform)
---
A library that gives you access to the powerful Parse Server backend from your Android app. For more information about Parse and its features, see [the website](https://parseplatform.org/), [getting started][guide], and [blog](https://blog.parseplatform.org/).
---
- [Getting Started](#getting-started)
- [Compatibility](#compatibility)
- [Add Dependency](#add-dependency)
- [Setup](#setup)
- [Contributing](#contributing)
- [More Parse Android Projects](#more-parse-android-projects)
# Getting Started
## Compatibility
The Parse Android SDK has the following Android API and [Gradle Plugin][gradle-plugin] compatibility.
| SDK version | Minimum API level | Targeting API level | Gradle Plugin |
|-------------|-------------------|---------------------|---------------|
| 1.26 | < API 16 | API 29 | 3.6.2 |
| 2.0 | >= API 16 | API 30 | 4.2.2 |
| 2.1 | >= API 21 | API 31 | 7.0.3 |
## Add Dependency
Add the line `maven { url 'https://www.jitpack.io' }` to your `settings.gradle` file, inside the `repositories` property, for example:
```gradle
dependencyResolutionManagement {
repositories {
maven { url 'https://www.jitpack.io' }
}
}
```
Older versions of Android studio require different steps. See the following list of Android Studio versions for alternative instructions. You can find the version of your Android Studio installation by clicking on *Help > About* in the top menu.
Arctic Fox | 2020.3.1 or older
>
> Add this in your root `build.gradle` file, **not** your module `build.gradle` file:
>
> ```gradle
> allprojects {
> repositories {
> ...
> maven { url "https://jitpack.io" }
> }
> }
> ```
>
> Then, add the library to your project `build.gradle` file.
Then, add the library to your (module:app) `build.gradle` file, replacing `latest.version.here` with the version of the Parse Android SDK you would like to use. We commend always updating your app to use the [latest release](https://github.com/parse-community/Parse-SDK-Android/releases) version.
```gradle
ext {
parseVersion = "latest.version.here"
}
dependencies {
implementation "com.github.parse-community.Parse-SDK-Android:parse:$parseVersion"
// for Google login/signup support (optional)
implementation "com.github.parse-community.Parse-SDK-Android:google:$parseVersion"
// for Facebook login/signup support (optional)
implementation "com.github.parse-community.Parse-SDK-Android:facebook:$parseVersion"
// for Twitter login/signup support (optional)
implementation "com.github.parse-community.Parse-SDK-Android:twitter:$parseVersion"
// for FCM Push support (optional)
implementation "com.github.parse-community.Parse-SDK-Android:fcm:$parseVersion"
// for Kotlin extensions support (optional)
implementation "com.github.parse-community.Parse-SDK-Android:ktx:$parseVersion"
// for Kotlin coroutines support (optional)
implementation "com.github.parse-community.Parse-SDK-Android:coroutines:$parseVersion"
// for RxJava support (optional)
implementation "com.github.parse-community.Parse-SDK-Android:rxjava:$parseVersion"
}
```
## Setup
Initialize Parse in a custom class that extends `Application`:
```java
import com.parse.Parse;
import android.app.Application;
public class App extends Application {
@Override
public void onCreate() {
super.onCreate();
Parse.initialize(new Parse.Configuration.Builder(this)
.applicationId("YOUR_APP_ID")
// if desired
.clientKey("YOUR_CLIENT_KEY")
.server("https://your-server-address/parse/")
.build()
);
}
}
```
The custom `Application` class must be registered in `AndroidManifest.xml`:
```xml
...
```
Note that if you are testing with a server using `http`, you will need to add `android:usesCleartextTraffic="true"` to your above `` definition, but you should only do this while testing and should use `https` for your final product.
See the [guide][guide] for the rest of the SDK usage.
# Contributing
We want to make contributing to this project as easy and transparent as possible. Please refer to the [Contribution Guidelines](CONTRIBUTING.md).
# More Parse Android Projects
These are other official libraries we made that can help you create your Parse app.
- [ParseGoogleUtils](/google) - Google login/signup.
- [ParseFacebookUtils](/facebook) - Facebook login/signup.
- [ParseTwitterUtils](/twitter) - Twitter login/signup.
- [Parse FCM](/fcm) - [Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-messaging) support for sending push notifications.
- [Parse KTX](/ktx) - Kotlin extensions for ease of developer use.
- [Parse Coroutines](/coroutines) - Kotlin Coroutines support for various Parse async operations
- [Parse RxJava](/rxjava) - Transform Parse `Task`s to RxJava `Completable`s and `Single`s
- [ParseLiveQuery](https://github.com/parse-community/ParseLiveQuery-Android) - Realtime query subscription.
- [ParseUI](https://github.com/parse-community/ParseUI-Android) - Prebuilt UI elements.
---
As of April 5, 2017, Parse, LLC has transferred this code to the parse-community organization, and will no longer be contributing to or distributing this code.
[guide]: http://docs.parseplatform.org/android/guide/
[open-collective-link]: https://opencollective.com/parse-server
[gradle-plugin]: https://developer.android.com/studio/releases/gradle-plugin