MovieDroid

Native Android Application for organized and categorized list of a user’s favorite movies and TV shows while keeping up to date with the latest releases.

Explore the docs »
View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

MovieDroid is a completely free and open source native android application that maintains an organized and categorized list of a user's favourite movies and TV shows. The app aims at helping a user keep track of the shows they have watched while keeping to up-to-date with the latest releases.

Built With

 

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• Android Studio

Installation

Below is an example of how you can install and set up your app.

1. Clone the repo

   git clone https://github.com/PEC-CSS/MovieDroid.git

2. Open Android Studio. Go to File->Open... and locate and open your cloned project. Then wait for all the dependencies to get installed.
3. To setup firebase for development on your local system, comment out all the firebase dependencies in the app level build.gradle file and run gradle sync.
4. Create a project on Firebase and add the package name of the project com.pec_acm.moviedroid
5. Enable Google Sign in authentication, Realtime Database and Firebase Storage in your Firebase project.
6. Add your SHA1 and SHA256 fingerprints to the app in the firebase project settings. You can get these by running the command:

• For windows

keytool -list -v -keystore C:\Users\your_user_name\.android\debug.keystore -alias androiddebugkey -storepass android -keypass android

• For mac

keytool -list -v -keystore ~/.android/debug.keystore -alias androiddebugkey -storepass android -keypass android

7. Download the google-services.json file in your firebase project and replace it with the google-services.json present in the cloned project.
8. Uncomment all the firebase dependencies and run gradle sync again.

Usage

• Open the cloned project in Android Studio.
• Select your preferred device and click on Run app.
• You can run the app using:
  • Virtual device - If you haven't created a virtual device yet, create one by going to Tools->AVD Manager (Device Manager in Bumblebee and above) and create a virtual device. Choose the device specifications according to your needs. Select your virtual device from the list of devices and run the app
  • Physical device - In your android device, go to settings and enable developer options. Connect your device to your system using USB or WiFi (Only for Android 11 and above)

For more examples, please refer to the Documentation

Contributors

This project exists thanks to all the people who contribute. [Contributing].

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Be sure to read the contribution guidelines before contributing.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

[email protected]

Acknowledgments

• Android docs
• TMDB API

(back to top)