Skip to content

Commit

Permalink
chore: improve readme file
Browse files Browse the repository at this point in the history
Signed-off-by: Eduardo Carrara <ecarrara.araujo@gmail.com>
  • Loading branch information
ecarrara-araujo committed Sep 13, 2017
1 parent d899f75 commit 6684b48
Show file tree
Hide file tree
Showing 8 changed files with 74 additions and 14 deletions.
88 changes: 74 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,86 @@
Popular Movies
====================================================
# Popular Movies

Concept app to fetch and list popular movies from
The Movie DB api (www.themoviedb.org).
Concept app to fetch and list popular movies from The Movie DB api (www.themoviedb.org).

Basic Instructions
===================================================
This application was created to exercise a few concepts regarding Android Development.

To start developing you should get and api key at
www.themoviedb.org.
If you just want to give it a try download the test apk [here](https://drive.google.com/file/d/0BxuNaEVyDit0d0wzcFZ0M2VqR0E/view?usp=sharing).

With the key in hands create app/secrets.properties
file. It is a key/value pairs based file and you
must add keys for Debug and Release versions using
the following entries:
## Table of Contents
* [Showcase](#showcase)
* [Feature List](#features)
* [Tools and Libs](#tools)
* [TODOs](#todos)
* [Basic Instructions](#instructions)

<a name="showcase"></a>
## Showcase

<p align="center">
<img src="screenshots/my_movies_recording.gif" align="center" width=200>
<img src="screenshots/mymovies_01.png" align="center" width=200>
<img src="screenshots/mymovies_02.png" align="center" width=200>
<img src="screenshots/mymovies_03.png" align="center" width=200>
<img src="screenshots/mymovies_04.png" align="center" width=200>
<img src="screenshots/mymovies_05.png" align="center" width=200>
<img src="screenshots/mymovies_06.png" align="center" width=400>
</p>

<a name="features"></a>
## Feature List

* List Top Rated and Most Popular Movies from The Movie DB Api.
* Display the Movie Details for a selected Movie.
* Allow the user to add movies to favorites.
* Allow user to watch trailers.
* Allow user to share trailers.
* Allow user to read reviews.
* List user's favorites.
* List favorite movie details.
* Offline support for favorite movies.
* Landscape layout for movie details.

<a name="tools"></a>
## Tools and Libs

* RxJava2
* ReactiveNetwork
* Retrofit2
* Picasso
* Gson
* AutoValues
* Butterknife
* Dagger2
* Android Support Libs:
* RecyclerView
* CardView
* Design Support Library
* ConstraintLayout
* Vector Drawables

<a name="todos"/></a>
## ToDos

* Improve error messages displayed to the user.
* Unit and Instrumented Tests.
* Animations

<a name="instructions"></a>
## Basic Instructions

To start developing you should get and api key at www.themoviedb.org.

With the key in hands create app/secrets.properties file. It is a key/value pairs based file and you
must add keys for Debug and Release versions using the following entries:

```
DEBUG_THE_MOVIE_DB_API_KEY=YOUR_KEY_HERE
RELEASE_THE_MOVIE_DB_API_KEY=YOUR_KEY_HERE
```

You can use the same key for both entries.

The entries will be available in the BuildConfig
generated class.
The entries will be available in the BuildConfig generated class.



Binary file added screenshots/my_movies_recording.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/mymovies_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/mymovies_02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/mymovies_03.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/mymovies_04.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/mymovies_05.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/mymovies_06.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6684b48

Please sign in to comment.