Giter Club home page Giter Club logo

its-me-debk007 / late-entry-project Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 799 KB

An offline friendly Barcode Scanner app. It allows users to swiftly mark students as late either by scanning their barcodes or manually entering their student numbers.

License: MIT License

Kotlin 100.00%
datastore-preferences firebase-app-distribution github-actions kotlin-coroutines livedata-viewmodel mvvm-architecture r8 retrofit room-database android

late-entry-project's Introduction

Language ย  Owner ย  License

Late Entry Project

  • Barcode scanner Android application, based on MVVM Architecture
  • An offline friendly app
  • Handled edge cases related to multiple clicks, multiple toasts, asking user permission, etc.
  • GitHub Actions & Firebase App distribution for CI/CD to reduce testing time by 20%
  • Implemented R8 to reduce apk size by 28.5%

Purpose ๐Ÿ“Œ

This app is created for an official purpose currently being used in our College, in order to easily keep a track on students coming late to the college. The app data is synced with a remote server, where data is stored permanently.

Functionality ๐Ÿ’ป

  • The user must authenticate himself first in order to start scanning
  • The app provides a quick barcode scanner, with an option to enable flash
  • In case of damaged camera/barcode, the user can manually enter student number and register a late entry
  • On scanning or manually entering data, student details pops up with name, branch, admission year, image, & student no (which are stored in app's database to provide quicker access)
  • In offline scenario, all entries are stored in app's database, & can be synced with the server afterwards
  • The Settings page include the option to sync locally stored student details & late entry records and other options related to the user

Preview ๐Ÿ‘€

Splash Login Student Details Settings

Basic Working โš’

Late.Entry.mp4

Offline Functionality ๐Ÿ‘จ๐Ÿปโ€๐Ÿญ

Offline.Functionality.mp4

Installation and Setup ๐Ÿš€

  • Clone this repository to your local machine
  • Generate a BASE URL for your server & update the variable in Constants.kt
  • Create a project in Firebase & generate appID and firebase token
  • Then add the following values to your GitHub Secrets:
    • SIGNING_KEY_ALIAS
    • SIGNING_KEY_PASSWORD
    • SIGNING_STORE_PASSWORD
    • FIREBASE_APP_ID
    • FIREBASE_TOKEN
  • Build the project and then run it

Tech Stack ๐Ÿ‘ฉ๐Ÿปโ€๐Ÿ’ป

  • Kotlin + Coroutines
  • ViewModel + LiveData
  • ROOM DB
  • Preferences Datastore
  • Retrofit
  • R8
  • GitHub Actions
  • Firebase App Distribution

Contributing ๐Ÿค

Join us in shaping the future of this project โ€“ your contributions are invaluable!

  • Fork the repository and create a new branch for your feature or bug fix
  • Make your changes and ensure that the code follows the project's coding standards
  • Write tests to cover your changes and ensure that existing tests pass
  • Submit a pull request, explaining the changes and the problem it addresses
  • A project maintainer will review your pull request, and upon approval, it will be merged into the main branch

License ๐Ÿ“œ

Distributed under the MIT License. See LICENSE file for more information.

๐ŸŒŸ If you find value in this project, please consider starring it! Your support keeps it thriving ๐Ÿš€

late-entry-project's People

Contributors

dependabot[bot] avatar garima652001 avatar its-me-debk007 avatar jyotsna2002 avatar

Watchers

 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.