Skip to content
This repository has been archived by the owner on Oct 9, 2020. It is now read-only.

Latest commit

 

History

History
168 lines (115 loc) · 9.9 KB

README.md

File metadata and controls

168 lines (115 loc) · 9.9 KB
Raw

Open Event Android

Build Status codecov.io Join the chat at https://gitter.im/fossasia/open-event-android Preview the app Codacy Badge Mailing List

The Open Event Android project consists of two components. The App Generator is a web application that is hosted on a server and generates an event Android app from a zip with JSON and binary files (examples here) or through an API. The second component we are developing in the project is a generic Android app - the output of the app generator. The mobile app can be installed on any Android device for browsing information about the event. Updates can be made automatically through API endpoint connections from an online source (e.g. server), which needs to defined in the provided event zip with the JSON files. The Android app has a standard configuration file, that sets the details of the app (e.g. color scheme, logo of event, link to JSON app data).

Have an issue? Create one using these:

Bug Feature Chore

Communication

Please join our mailing list to discuss questions regarding the project: https://groups.google.com/forum/#!forum/open-event

Our chat channel is on gitter here: https://gitter.im/fossasia/open-event-android


1. Android App

This is a generic app that has two parts:

A) A standard configuration file, that sets the details of the app (e.g. color scheme, logo of event, link to JSON app data). A sample of the JSON format is maintained in the Open Event Repository.

B) A JSON API provided by open-event-orga-servers server (Code maintained here).

Sample App

A sample app for testing purposes is automatically built after commits in the repository. Please download and test the app that is using the code from the dev branch here and the code from the master branch here.

Screenshots of a sample Android app

Android App Development Set up

Please find info about the set up of the Android app in your development environment here.

Data retrieval

  • The orga-server provides the data which is stored in its backend database in a json format.
  • The app on startup picks up data from a JSON file in its assets folder if the version number of data is -1, which happens when there is no internet connection
  • If there is a valid internet connection, the data download starts from the server.
  • Also there is a check on the version of data already there in the app's database. If data is stale then only it is downloaded.
  • If database is empty then firstly JSON file in assets is accessed but if internet is available , latest data is downloaded.

Libraries used and their documentation

Devices tested on

Device Android Version Skin/ROM
OnePlus 3 Android 6.0 OxygenOS
Nexus 5X Android 7.0 AOSP
Nexus 5X Android 6.0 CyanogenMod 13
Nexus 5 Android 4.4 AOSP
Redmi Note 3 Android 5.0 MIUI
Moto G4 Plus Android 7.0 Stock Android

2. App Generator

Technology Stack

  • Flask
  • Celery
  • JDK 8
  • Android SDK
  • Redis

Setup and Installation

How to install The Open Event Android App Generator on a Generic Server

Installation instructions for generic servers are here.

How to install The Open Event Android App Generator on Google Cloud/Kubernetes

Installation instructions for Google Cloud Kubernetes are here.

How to install The Open Event Android App Generator on AWS

Installation instructions for AWS servers are here.

How to install The Open Event Android App Generator on Digital Ocean

Installation instructions for Digital Ocean servers are here.

How to install The Open Event Android App Generator on Docker

Installation instructions for docker are here.

Note: You will need to install Lombok Plugin in Android Studio in order to properly access generated methods of data classes

Contributions, Bug Reports, Feature Requests

This is an Open Source project and we would be happy to see contributors who report bugs and file feature requests submitting pull requests as well. Please report issues here https://github.com/fossasia/open-event-droidgen/issues

Branch Policy

We have the following branches

  • development All development goes on in this branch. If you're making a contribution, you are supposed to make a pull request to development. PRs to master must pass a build check and a unit-test (app/src/test) check on Travis
  • master This contains shipped code. After significant features/bugfixes are accumulated on development, we make a version update, and make a release. All tagged commits on master branch will automatically generate a release on Github with a copy of fDroid-debug and GooglePlay-debug apks.
  • apk This branch contains two apk's, that are automatically generated on merged pull request a) from the dev branch and b) from the master branch using the Open Event sample of the FOSSASIA Summit.

Code Style

For contributions please read the CODESTYLE carefully. Pull requests that do not match the style will be rejected.

Commit Style

For writing commit messages please read the COMMITSTYLE carefully. Kindly adhere to the guidelines. Pull requests not matching the style will be rejected.

License

This project is licensed under the GNU General Public License v3. A copy of LICENSE is to be present along with the source code. To obtain the software under a different license, please contact FOSSASIA.

Maintainers

The project is maintained by