Skip to content
arthur-mrgt edited this page Dec 19, 2024 · 23 revisions

Welcome to the Icebreakrr Wiki

Overview

Icebreakrr is an app that enables users to communicate with others in close proximity. Its first use case is for newcomers in a neighborhood who want to start a conversation or "break the ice" with their neighbors. By using the app, users can send private messages to those nearby. To ensure a positive experience, the app includes safeguards to prevent misuse and unwanted interactions.

Scrum process documents:

Scrum documents

Architecture diagram:

https://excalidraw.com/#json=UHSCsNg6bnPZTBE0mmx34,Fj4_GcyW0nT7Px84_37y-w

Figma:

https://www.figma.com/design/eCJ4gIM5Yq8mz8Fblrk8Yb/IceBreakrr-App-Mockup?node-id=21-10&node-type=canvas&t=FfZGVcuO9BptD4V1-0

Figma M1 Version:

https://www.figma.com/design/eCJ4gIM5Yq8mz8Fblrk8Yb/IceBreakrr-App-Mockup?version-id=6879196338&node-id=21-9&node-type=canvas&t=qgWXIEWtSg2Ul60b-0

Figma M2 Version:

https://www.figma.com/design/eCJ4gIM5Yq8mz8Fblrk8Yb/IceBreakrr-App-Mockup?version-id=2151131897396137126&node-id=21-9&node-type=canvas&t=WkdePNwcquE8suuM-0

Figma M3 Version:

https://www.figma.com/design/eCJ4gIM5Yq8mz8Fblrk8Yb/IceBreakrr-App-Mockup?version-id=2163937681701519855&node-id=0-1&p=f&viewport=149%2C236%2C0.23&t=YiFSiE5c6rvwA2vT-0

Tech Stack:

  • Language: Kotlin (with Android Studio)
  • UI Framework: Jetpack Compose
  • Backend: Firebase (Firestore, Authentication, Functions with TS/node.js)
  • Architecture: MVVM (Model-View-ViewModel) pattern

Explore the Wiki

  1. Global Organization

    • Meeting Schedule: When and where we meet, and for what purpose.
    • Scrum Master and Product Owner: Details about team roles and their turnovers.
    • Global Roadmap: Key milestones and long-term goals for the project.
  2. Guidelines

    • Code Review Process: Guidelines for submitting and reviewing pull requests.
    • Communication Protocol: How we handle complex merges and conflicts.
    • Branch Naming Conventions: Standardized naming patterns for branches.
    • Testing Protocol: Testing guidelines, including unit tests, mock dependencies, and coverage expectations.
  3. Scrum documents

    • Team Retrospective: Team review of successes and areas to improve.
    • Stand-Up Minutes: Summaries of key discussions from daily standups and other meetings.
    • Individual retrospective: Personal reflection on progress and challenges.
  4. Project Conventions

    • File Naming: Rules for naming files, classes, and functions.
    • Variable Naming: Conventions for variables, constants, and properties.
    • Formatting and Spacing: Best practices for indentation, braces, and line length.
    • Jetpack Compose Best Practices: Guidance for managing state, recomposition, and more in Compose.

Feel free to suggest additions or request changes if any part of this wiki is missing or does not meet your expectations.