Code Monkey home page Code Monkey logo

chai's Introduction

droidconKE Android App

Android app for the first ever Android Developer conference-droidcon in Nairobi 2018

This project is the Android app for the conference. The app supports devices running Android 5.0+, and is optimized for phones and tablets of all shapes and sizes.

Source

The source code in this repository reflects the app as of droidconKE 2018.

Features

The app displays a list of conference events - sessions, office hours, app reviews, codelabs, etc. - Users can see details about events.

The app also displays a map of the venue and shows informational pages to guide attendees during the conference.

Schedule screenshot

Development Environment

The app is written in Java and Kotlin and uses the Gradle build system.

To build the app, use the gradlew build command or use "Import Project" in Android Studio. A canary or stable version >= 3.2 of Android Studio is required and may be downloaded here.

Architecture

The architecture is built around Android Architecture Components.

We followed the recommendations laid out in the Guide to App Architecture when deciding on the architecture for the app. We kept logic away from Activities and Fragments and moved it to ViewModels. We observed data using LiveData

We used a Repository layer for handling data operations.droidconKE's data comes from a few different sources - user data is stored in Cloud Firestore (either remotely or in a local cache for offline use), user preferences and settings are stored in SharedPreferences, conference data is stored remotely and is fetched and stored in memory for the app to use, etc. - and the repository modules are responsible for handling all data operations and abstracting the data sources from the rest of the app (we liked using Firestore, but if we wanted to swap it out for a different data source in the future, our architecture allows us to do so in a clean way).

Firebase

The app makes considerable use of the following Firebase components:

  • Cloud Firestore is our source for all conference and user data. Firestore gave us automatic sync and also seamlessly managed offline functionality for us.
  • Crashlytics allowed us to detect bugs and catch errors.
  • Firebase Cloud Messaging let us inform the app about changes to conference data on our server.
  • Remote Config helped us manage in-app constants.
  • Firebase Authentification helped us to provide easy and secure authentification using email.

[ ๐Ÿšง Work in progress ๐Ÿ‘ทโ€โ™€๏ธโ›๐Ÿ‘ท๐Ÿ”ง๏ธ ๐Ÿšง ]

  • Rewriting .droidconKE app in Kotlin and taking advantage of kotlin features like coroutines,kotlin android extensions etc
  • Version 2.0 features writeup(UI Improvements, Event Reservation Feature,Starring Session Feature etc)
  • CI/CD Setup
  • Offline First Architecture Improvements

License

MIT License

Copyright (c) 2018 droidConKE

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

chai's People

Contributors

renovate[bot] avatar tamzi avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

chai's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

  • Update all dependencies (JetBrains/qodana-action, gradle, gradle/wrapper-validation-action, androidx.compose.ui:ui-tooling-preview, androidx.compose.material3:material3, androidx.activity:activity-compose, androidx.core:core-ktx, androidx.compose:compose-bom, com.android.tools.lint:lint-tests, com.android.test, com.android.library, com.android.application, com.android.tools.lint:lint-api)
  • Update kotlin (composeOptions, com.google.devtools.ksp, org.jetbrains.kotlin.jvm, org.jetbrains.kotlin.android, org.jetbrains.kotlin:kotlin-stdlib-jdk8)

Detected dependencies

github-actions
.github/workflows/main.yml
  • styfle/cancel-workflow-action 0.12.1
  • actions/checkout v4
  • gradle/wrapper-validation-action v1
  • actions/setup-java v4
  • actions/checkout v4
  • gradle/wrapper-validation-action v1
  • actions/setup-java v4
  • actions/checkout v4
  • gradle/wrapper-validation-action v1
  • actions/setup-java v4
  • actions/checkout v4
  • gradle/wrapper-validation-action v1
  • actions/setup-java v4
  • reactivecircus/android-emulator-runner v2
.github/workflows/qodana.yml
  • actions/checkout v4
  • JetBrains/qodana-action v2023.3.1
gradle
gradle.properties
settings.gradle.kts
build.gradle.kts
  • com.android.application 8.2.2
  • com.android.library 8.2.2
  • org.jetbrains.kotlin.android 1.9.0
  • org.jetbrains.kotlin.jvm 1.9.0
  • com.google.devtools.ksp 1.9.0-1.0.12
  • com.android.test 8.2.2
chai/build.gradle.kts
  • composeOptions 1.5.0
  • androidx.compose:compose-bom 2024.01.00
  • junit:junit 4.13.2
chaidemo/build.gradle.kts
  • composeOptions 1.5.0
  • androidx.compose:compose-bom 2024.01.00
  • androidx.core:core-ktx 1.12.0
  • androidx.activity:activity-compose 1.8.2
  • androidx.compose.material3:material3 1.1.2
  • androidx.compose.ui:ui-tooling-preview 1.6.0
  • junit:junit 4.13.2
chailinter/build.gradle.kts
  • junit:junit 4.13.2
  • com.android.tools.lint:lint-tests 31.2.2
gradle/init.gradle.kts
  • com.diffplug.spotless:spotless-plugin-gradle 6.25.0
gradle/libs.versions.toml
  • org.jetbrains.kotlin:kotlin-stdlib-jdk8 1.9.0
  • com.android.tools.lint:lint-api 31.2.2
gradle-wrapper
gradle/wrapper/gradle-wrapper.properties
  • gradle 8.5

  • Check this box to trigger a request for Renovate to run again on this repository

[FR]: Qodana CI setUp #18

Is there an existing issue for this?

  • I have searched the existing issues

Describe the problem

Monitor project code quality .

Describe the solution

Set up Qodana on ci to generate reports!

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

[Bug]: failed workflows

Is there an existing issue for this?

  • I have searched the existing issues

Is there a StackOverflow question about this issue?

  • I have searched StackOverflow

What happened?

Failed workflows as a result of lower java version in CI build flow

Relevant logcat output

Everything in here after an upgrade: 
https://github.com/droidconKE/chai/actions

Code of Conduct

  • I agree to follow this project's Code of Conduct

[FR]: BuildLogic

Is there an existing issue for this?

  • I have searched the existing issues

Describe the problem

How can we have shared build files in the project. As many developers use the project and anticipation of other app spinOffs makes sense to have a central way top control all builds

Describe the solution

Have

  • a central library that has build logic for all projects
  • A quality gate from ktlint enabled that can be run on command

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

[FR]: have dckeswag as a separate app

Is there an existing issue for this?

  • I have searched the existing issues

Describe the problem

instead of minimizing importance of the dckeswag app separate it and run it as a separate app

Describe the solution

Remove dckeswag and have it as a separate app :)

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

[FR]: Code Quality Gates

Is there an existing issue for this?

  • I have searched the existing issues

Describe the problem

While putting together a POC for potential asset handling (#13), I noticed we don't have any linting other than the standard android, or any static analysis tools.

Describe the solution

It would be great to align on the quality gates we want to use so as not to have tons of formatting/linting/etc. changes later.

Additional context

I like to use:

Code of Conduct

  • I agree to follow this project's Code of Conduct

[Documentation]: Write up on composeBOM

Is there an existing issue for this? no

  • I have searched the existing issues

Page URL (type "NEW" for a new page suggestion)

NEW:composeBOM and builds

What's the documentation problem or suggestion?

Add documentation for the composeBOM section to explain how it works.

In short:
composeBOM

Code of Conduct

  • I agree to follow this project's Code of Conduct

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.