Giter VIP home page Giter VIP logo

mobileapp2ca2's Introduction

Mobile App 2 CA 2 Technical Report

This README.md file acts as the technical report for this project.

Personal Statement

I declare that the code presented is my own, unless explicitly referenced or attributed to other sources.

I understand that SETU has a plagiarism policy which can lead to expulsion of students. As such, I take full responsibility for the originality and authenticity of this project. Dominik Kawka (20093701)

Functionality

  • User functionality: Creating and logging into an account.
  • Google User Integration
  • Create, View, Edit and Delete your tracks, managed via firebase
  • Adding tracks to favourite
  • Uploading/ changing profile picture to user
  • View other users' submitted tracks
  • Filter through various tracks via search bar option
  • Pinpoint tracks starting/ending point via google maps, including filters
  • Option to choose between Light and Dark mode
  • Swipe support; swipe down to refresh list, left/right for editing/deleting
  • Navigation Architecture Components + Model,View,ViewModel Architecture Pattern

External Libraries Used

  • Firebase Auth + DB + Storage: Managing users, storing tracks,favourites and profile pictures
  • Google Maps: Displaying user tracks on maps via pinpoints.
  • Picasso: Image Handling
  • Retrofit2: Creating custom API Model
  • Timber: Used for logging/debugging

UML + Classes Diagrams

UML + Classes Diagram

Firebase

  • tracks: All Tracks
  • user-tracks: Tracks belonging to specific users
  • favourites: stores ID of track, and the ID of the user

UX / DX Approach

I followed the Android Material Design as a guideline for the User Experience and Design.

Git Approach

Git workflow involved merging changes into a develop branch, which then flowed into a release branch, before finally integrating into the main branch. The release branch is used to create tagged releases.

References

mobileapp2ca2's People

Contributors

dominikkawka avatar

Watchers

Dave Drohan (SETU) 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.