Skip to content

jakobhanna/wsandroid

 
 

Repository files navigation

WarmShowers for Android Build Status Gitter chat

Get it on Google Play

How may I help the project?

We’re very happy that you are thinking about helping us! A great starting point would probably be to join us in the Gitter chat, but you can also have a look through our Issues and especially the ones labelled Help needed

If you find something within the code you’d like to see changed for performance, security, accessibility, data protection, or whatever reason you see fit: Please feel free to fork the project and send us a pull request once you’re done with your changes.

Things that are always helpful

  • More translations (see #234)

    • We currently support English, German, French, and Spanish
    • Currently, we do not use Transifex, POEditor, or other services but as soon as someone would like to help, we’re going to look into it
  • Tests of any kind—UI tests, unit tests, integration tests, you name it

How to build the app

The Warmshowers API now requires an API key.

Use the development proxy server

Head over here and get yourself a client certificate for the development proxy server. Then either set wsDevKeyStoreFile in app/build.gradle or set the environment variable WS_DEV_KEYSTORE.

Then you are ready to build the app:

export WS_DEV_KEYSTORE=<path_to_your_keystore_file.p12>
./gradlew build

The development proxy accesses the Warmshowers development site at https://dev.warmshowers.org.

Important: You are not allowed to distribute any app that uses the development proxy server!

Use an API key

If you happen to have an API key then either edit the variables wsApiUserId and wsApiKey in app/build.gradle or set the environment variables WS_API_USER_ID and WS_API_KEY.

Then you are ready to build the app:

export WS_API_USER_ID=<your_user_id>
export WS_API_KEY=<your_api_key>
./gradlew build

The app runs against Warmshower's development API by default. To switch to the production servers set the environment variable WS_USE_PRODUCTION.

OSS libraries in use (aka, Thank You!)

Without these libraries, our lives would be a whole lot more difficult. So thank you all for developing and maintaining those fine pieces of software!

About

WarmShowers for Android

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 100.0%