Skip to content
This repository has been archived by the owner on May 28, 2020. It is now read-only.

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
lizhaotailang committed Mar 29, 2017
1 parent e7042f7 commit ae3f59b
Showing 1 changed file with 3 additions and 110 deletions.
113 changes: 3 additions & 110 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# Espresso Android App
![icon](https://github.com/TonnyL/Espresso/blob/master/mobile/src/main/res/mipmap-xxxhdpi/ic_launcher.png)

[中文版](#中文版)

Espresso is an express delivery tracking app designed with Material Design style, built on MVP(Model-View-Presenter) architecture with RxJava2, Retrofit2, Realm database and ZXing.

The source code in this repository reflects the app which supports mobile devices running Android 5.0+.
Expand All @@ -13,7 +11,7 @@ The source code in this repository reflects the app which supports mobile device
+ Support add packages by inputting the package number manually or just scanning the express sheet.
+ Support recognize the company of a package automatically.
+ Support view the package's details such as the latest location.
+ Support search information about the express companies.
+ Support search packages that you added and the information about the express companies.
+ Launcher widgets are provided.
+ Day mode and night mode are supported.
+ Support push notification when the package is refreshed.
Expand All @@ -39,112 +37,7 @@ Check out the master branch:
git checkout master
```

Notice: If you want to review a different branch, replace the `master` with the name you want to checkout if it does exist. Finally open the `Espresso/` directory in Android Studio.

Suggestion: It is better for you to update your Android Studio to version 2.3 when you open this project.

### To-dos
This project is still in progress. Here are the some features that I will finish in the future.

- [x] Refreshing package details by accessing the network.
- [x] Launcher app widgets.
- [x] App Shortcuts on devices that running Android 7.1+.
- [x] Material design app onboarding pages.
- [x] Chrome Custom Tabs.
- [x] Alphabet indexing for companies list.
- [x] Search packages and companies.
- [x] Day and night mode.
- [x] Service to build notifications.
- [x] Settings and about page.
- [ ] Supporting Android Wear.
- [ ] UI test and unit test.

### Help Me Improve This App
+ As you can see at the screenshots, some images in Espresso app are not suitable. So if you are a designer and familiar with **Material Design** and want to help me make the app look better, please email me.
+ If you want to improve the translation of Espresso, do not hesitate to email me. Let us make Espresso more and more popular all over the world.

### Libraries Used in This App
Name | Introduction | Version
----- | ------ | ---
[Android Support Libraries](https://developer.android.com/topic/libraries/support-library/alphabet.html) | The Android Support Library offers a number of features that are not built into the framework. These libraries offer backward-compatible versions of new features, provide useful UI elements that are not included in the framework, and provide a range of utilities that apps can draw on. | 25.2.0
[CircleImageView](https://github.com/hdodenhof/CircleImageView) | A circular ImageView for Android | 2.1.0
[Gson](https://github.com/google/gson) | A Java serialization/deserialization library that can convert Java Objects into JSON and back. | 2.7
[MaterialDateTimePicker](https://github.com/wdullaer/MaterialDateTimePicker) | Pick a date or time on Android in style. | 3.1.3
[Realm](https://github.com/realm/realm-java) | Realm is a mobile database: a replacement for SQLite & ORMs. | 3.0.0
[Retrofit](https://github.com/square/retrofit) | Type-safe HTTP client for Android and Java by Square, Inc. | 2.2.0
[RxAndroid](https://github.com/ReactiveX/RxAndroid) | RxJava bindings for Android. | 2.0.1
[RxJava](https://github.com/ReactiveX/RxJava) | RxJava – Reactive Extensions for the JVM – a library for composing asynchronous and event-based programs using observable sequences for the Java VM. | 2.0.1
[ZXing](https://github.com/zxing/zxing) | ZXing ("zebra crossing") is an open-source, multi-format 1D/2D barcode image processing library implemented in Java, with ports to other languages. | 3.3.0

### Thanks to
+ [Express 100](https://www.kuaidi100.com/)
+ [googlesamples](https://github.com/googlesamples) - [android-architecture](https://github.com/googlesamples/android-architecture):A collection of samples to discuss and showcase different architectural tools and patterns for Android apps.
+ [google](https://github.com/google) - [iosched](https://github.com/google/iosched):The Google I/O 2016 Android App.
+ [fython](https://github.com/fython) - [PackageTracker](https://github.com/fython/PackageTracker):The New ExpressHelper for Android.
+ [hefuyicoder](https://github.com/hefuyicoder) - [ListenerMusicPlayer](https://github.com/hefuyicoder/ListenerMusicPlayer):A Grace Material Design Music Player.
+ [BreadKid](https://github.com/BreadKid) - [SearchItem](https://github.com/BreadKid/SearchItem):小搜搜——商品条形码／二维码搜索APP.
+ [YoulunZhai](https://plus.google.com/+YoulunZhai) - The posters.
+ Other people who help me solve the problems when I met some difficult bugs.

### License
```
Copyright 2017 lizhaotailang
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.
```

## 中文版

# Espresso Android App
![icon](https://github.com/TonnyL/Espresso/blob/master/mobile/src/main/res/mipmap-xxxhdpi/ic_launcher.png)

Espresso是一款基于MVP(Model-View-Presenter)架构, Material Design设计风格, 采用RxJava2, Retrofit2, Realm数据库和ZXing开发的快递追踪应用。

本仓库中的源代码仅支持运行Android 5.0及以上的移动设备。

### 特点

+ 支持全球640余家快递公司。
+ 可以通过手动或扫描快递单的形式添加包裹。
+ 自动识别包裹所属的快递公司。
+ View the package's details such as the latest location.可以查看
+ Search information about the express companies.
+ 桌面小部件。
+ 日间及夜间模式。
+ Get important notification when the package is on delivery.
+ Send feedback on using experience from your devices.

### Screenshots
![screenshot0](https://github.com/TonnyL/Espresso/blob/master/art/screenshot0.png)

![screenshot1](https://github.com/TonnyL/Espresso/blob/master/art/screenshot1.png)

### How to Work with the Source
I hope the source code for this app is useful for you as a reference or starting point for creating your own app. Here is some instructions to help you better build and run the code in Android Studio.

Clone the Repository:

```
git clone https://github.com/TonnyL/Espresso.git
```

Check out the master branch:

```
git checkout master
```

Notice: If you want to review a different branch, replace the `master` with the name you want to checkout if it does exist. Finally open the `Espresso/` directory in Android Studio.
Notice: If you want to review a different branch, replace the `master` with the name you want to checkout (if it does exist). Finally open the `Espresso/` directory in Android Studio.

Suggestion: It is better for you to update your Android Studio to version 2.3 when you open this project.

Expand All @@ -154,7 +47,7 @@ This project is still in progress. Here are the some features that I will finish
- [x] Refreshing package details by accessing the network.
- [x] Launcher app widgets.
- [x] App Shortcuts on devices that running Android 7.1+.
- [x] Material design app onboarding pages.
- [x] Material design app onboard pages.
- [x] Chrome Custom Tabs.
- [x] Alphabet indexing for companies list.
- [x] Search packages and companies.
Expand Down

0 comments on commit ae3f59b

Please sign in to comment.