Code Monkey home page Code Monkey logo

relay-me-android-studio-project's Introduction

1. Introduction

This repo contains all the code needed to for the Android app Relay ME. There is a wiki page, which introduces this app and answers some common questions. You can find it here.

2. Quickstart

In order to get started, follow these steps:

  • Clone this repo.
  • Create a project in Android Studio, or build using Gradle: ./gradlew build.

3. Development

The rest of this document is about the development process.

3.1. Contribution

In order to contribute, fork and raise pull-requests against this repo. Once you have started contributing, you will be added as a collaborator.

3.2. Collaboration

There is a Slack group used for discussions and discussions around development of this app. Please send an email to [email protected] to be added to this group.

3.3. Tasks

There is a Trello board, where all the current tasks are kept in. This board is public, so that everyone can see what is currently being done for this project.

3.4. Releasing to Google Play

This is currently done manually, but this will be automated in the future.

4. Server-side component

This app requires a server-side component, which is used for the OAuth flow with Google. Its code lives here, and you can access it live on on Heroku for testing. In order to modify the Android app, you don't need to touch the server-side component.

4.1. Whey does Relay ME use browser OAuth, instead of a native one?

At the time this application was written there was limitations and concerns about native OAuth. For example, this was a real concern.

4.2. Running your own server-side component

  • Follow the instructions in here.
  • Clone the server-side settings, update the settings accordingly, build, and replace the jar file relayme-serverside.jar with your own artifact.
  • Now Relay ME will talk to your own server-side component.
  • Re-install the app, so its server-side settings is reset.

relay-me-android-studio-project's People

Contributors

n0rmzzz avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.