deissh / compressor-head-android

This is an android library for the compressor-head project.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Compressor Head Android

Codacy Badge Build Status

What is compressor-head-android?

Compressor Head on Android is an Android clint that generates image URLs for the Compressor Head web application. It takes various specifications of an image such as its URL or source, width, height, and format (PNG, JPEG or WEBP) as arguments to generate a usable image URL in accordance with the dimensions and format specified.

What is Compressor Head?

Compressor Head is a fast web application based on Python to resize images. For a more detailed explanation, visit the Compressor Head project.

Setting up the Project

  1. Fork the repository by clicking on the Fork icon at the top right corner of this page.

  2. Clone the repository on to your local machine by running the following commands on git:

     git clone https://github.com/[YOUR-USERNAME]/compressor-head-android.git
    
  3. If you need help, refer Forking and Cloning in git. You can also ask for help on the chat.

  4. Download and install Android Studio, an IDE for android application development.

  5. You will also need to download the Android SDK from the IDE itself.

  6. Import the forked repository into Android Studio by clicking on files-->Open and navigate to the directory where you forked the repository.

Running the Application

Via your own android smartphone.

  • Enable USB Debugging on your phone.
  • Click Run on the Android Studio tool bar, or Shift + F10 to run the app.

By running a virtual device. - Setup a Android Virtual Device in the IDE. - Then running the application by clicking on Run on the Android Studio tool bar, or Shift + F10 and then choose the newly created virtual device to run the app.

Contributing to the project

  1. Make your intended changes on your locally cloned repository.
  2. Commit the changes and push the commit to your forked repository on GitHub.
  3. Ensure the changes on the commit pushed to your GitHub fork are correct.
  4. Create a Pull Request requesting to merge the commits on your fork to this repository.
  5. Write a very conscise but informative pull request message explaining the test cases in your pull request. Remember to use your words wisely.

Additional Learning

About

This is an android library for the compressor-head project.


Languages

Language:Java 100.0%