Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gejiaheng/protein
:egg: An Android App for Dribbble
https://github.com/gejiaheng/protein
android-app autovalue dribbble dribbble-client mvp-android mvp-architecture rxjava2
Last synced: about 5 hours ago
JSON representation
:egg: An Android App for Dribbble
- Host: GitHub
- URL: https://github.com/gejiaheng/protein
- Owner: gejiaheng
- License: apache-2.0
- Created: 2017-06-08T14:26:24.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-10-20T17:20:49.000Z (about 6 years ago)
- Last Synced: 2024-10-30T21:03:17.725Z (14 days ago)
- Topics: android-app, autovalue, dribbble, dribbble-client, mvp-android, mvp-architecture, rxjava2
- Language: Java
- Homepage:
- Size: 3.56 MB
- Stars: 583
- Watchers: 15
- Forks: 78
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Protein
Protein is an atypical [Dribbble](https://dribbble.com/) App designed with one cup of simplicity and two spoons of fun. It is fully open sourced but also published on [Google Play](https://play.google.com/store/apps/details?id=com.ge.protein).
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](http://developer.dribbble.com/changes/), 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](https://github.com/gejiaheng/Protein/blob/master/app/src/main/java/com/ge/protein/shot/ShotActivity.java), empowers your native App.
- Test: Yes, a few UI tests. More coming, still working on this.
## Screenshots
| Main | Shot | User | Comment |
|:----:|:----:|:----:|:-------:|
| |  | | 
## Build
### Get Started
```shell
./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 ([email protected]).
### 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](http://developer.dribbble.com/v1/#rate-limiting). I suggest you
register a dribbble application [here](http://developer.dribbble.com/) 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](https://github.com/gejiaheng/Protein/blob/master/app/src/main/java/com/ge/protein/data/api/ApiConstants.java).
## Distribute
Protein is published on [Google Play](https://play.google.com/store/apps/details?id=com.ge.protein). The distribution is maintained by Jiaheng Ge ([email protected]).
The [GitHub Contributors page](https://github.com/gejiaheng/Protein/graphs/contributors) will have an entry in the App.
## Contribute
[Protein is an Open Source Project](https://github.com/gejiaheng/Protein/blob/master/CONTRIBUTING.md)
Please check out Protein's [Roadmap](https://github.com/gejiaheng/Protein/wiki/Roadmap) and [Todos](https://github.com/gejiaheng/Protein/wiki/Todos)
## License
Copyright 2017 Jiaheng Ge ([email protected])
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.