Skip to content

Latest commit

 

History

History
78 lines (62 loc) · 4.33 KB

README.md

File metadata and controls

78 lines (62 loc) · 4.33 KB
Raw

Image

Protein

Protein is an atypical Dribbble App designed with one cup of simplicity and two spoons of fun. It is fully open sourced but also published on Google Play. You can discuss how-tos and best practices on creating an Android App around Protein.

Attention

Due to the breaking change of Dribbble API v1, I need to migrate to API v2. Unfortunately, most of the current features are't supported by API v2. So, in the following months, I'll:

  • Try to recover some basic features
  • Implement a redesign of Protein

Highlights

  • Material Design: Not a typical Material Design App, but you will find some familiar elements in Protein.
  • MVP architecture: Whole project is built on MVP. Views are implemented by custom views and fragments with activity being pure container.
  • RxJava: Model layer supported by RxJava. Also compose activity and fragment's lifecycles.
  • Auto Value: Auto valued all the models to gain some benefits.
  • Configuration change: Handles configuration changes like a charm.
  • Firebase: Firebase Analytics integrated. Only configured for product flavor play.
  • Stetho: Better debug.
  • Deep link: Showcase deep link mechanism with ShotActivity, empowers your native App.
  • Test: Yes, a few UI tests. More coming, still working on this.

Screenshots

Main Shot User Comment

Build

Get Started

./gradlew installOpenDebug

Attentions

As we are using bleeding edge versions of gradle wrapper, gradle plugin and Android Studio. You may come across some build problems, don't panic, try the followings:

  • Update Android Studio to latest beta/canary version. Current is Android Studio 3.0 Beta 5
  • If you're having gradle plugin too old error, do as /build.gradle tells you.
  • Use gradlew instead of your local gradle.
  • Try to clean project and restart Android Studio.
  • If none of the above solve your problem, file an issue.

Product Flavors

  • open: For open source purpose, use this flavor to develop and debug.
  • play: For Google Play publish, maintained by Jiaheng Ge (gejiaheng@gmail.com).

Dribbble OAuth

Dribbble API client id, client secret and client access token for flavor open are placed in dribbble_config_open.properties. The property file for flavor play is not committed to git.

You may come across API rate limiting according to Rate Limiting. I suggest you register a dribbble application here if you want to develop continually. As for Callback URL, you can use x-protein-oauth-dribbble://callback as default. Or you can define your own url, and modify relative constants in ApiConstants.java.

Distribute

Protein is published on Google Play. The distribution is maintained by Jiaheng Ge (gejiaheng@gmail.com). The GitHub Contributors page will have an entry in the App.

Contribute

Protein is an Open Source Project

Please check out Protein's Roadmap and Todos

License

Copyright 2017 Jiaheng Ge (gejiaheng@gmail.com)

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.