meganyyu / prolific Goto Github PK

Need to create new data model to track activity/interactions!

• Add camera selection ability to submission
• Setup Firebase Storage on iOS
• Update data models and Firestore database

Tasks

• Design basic badges on paper and design schema
• Create Badge model and model builder classes on client side
• Add DAO methods that can fetch or update badge data from server side
• Set up ProfileVC to load badge data
• Implement some of the basic badges

Basic badges:

• Contributor Badge: submit 50 snippets per level
• Big Hit Writer Badge: win 20 rounds
  • will have to implement this later, once Cloud Functions are set up
• Creator Badge: compose 20 projects per level (later on, change so that the higher level you are, the more projects you have to compose)

Adding to Cloud Firestore's Users documents

Note: bold text indicates a collection, italicized text indicates a document.

users

• user 1
  • other user metadata
  • badges
    • contributor-badge
      • level
      • goalCompletedSoFar: amount completed so far for level
      • totalGoal: total amount needed to complete level
    • big-hit-writer-badge
      • ...
    • creator-badge
      • ...

• create any necessary base cells (e.g. with rounded edges and appropriate drop shadow)

• Resource

• Set up floating button
• Set up Create Project screen
• Create or update relevant DAO methods
• Connect creation screen with server

• video, voice recordings, etc

• Add buttons to vote on a snippet cell
• Update relevant models on tapping buttons
• Update Firestore with new data

• create any necessary base buttons (e.g. with rounded edges and different sizes)

• Setup User model in Xcode
• Setup basic Snippet model in Xcode
• Setup basic Project model in Xcode
• Setup basic Round model in Xcode

• Make sure app uses animations (e.g. fade in/out, e.g. animating a view growing and shrinking)

• Create a profile view with a button to change profile picture
• Implement a camera function
• Add camera selection ability to profile view
• Setup Firebase Storage on iOS
• Update data models and Firestore database

Resource: https://stackoverflow.com/questions/2215672/how-to-change-the-push-and-pop-animations-in-a-navigation-based-app

• Create a pop up from bottom animation for login/register screen

• User can view other user’s profiles by tapping on the author photo of a snippet, and see their points/what projects they've created

Programmatically build out navigational skeleton and some basic skeleton views

• Login View Controller
• Register View Controller
• Main Tab Bar Controller
• Home View Controller
• Favorites View Controller

• Add follow button to project details view
• Update models with the new follow
• Update Firestore database with the new data

• Setup login view controller
• Setup home view controller with a logout button
• Add basic password-based login/logout functionality with Firebase Auth
• Add authentication state persistence, i.e. automatically sign in if user is already authenticated upon opening app - Resource: Manage Users in Firebase

• Depending on what options are available on a user's device, offer option to select between camera or gallery

• Choose/add external library to add visual polish - CHOICE: Lottie
• Resources: (LottieFiles)[https://lottiefiles.com/], (Lottie iOS github)[https://github.com/airbnb/lottie-ios]
• Use this statement to install file, because latest version of Lottie uses Swift, not Obj-C: pod 'lottie-ios', '2.5.3'

• Draft up Cloud Firestore data model on paper
• Setup Cloud Firestore data model on Firebase Console
• modify as needed!

User can receive push notifications or see notifications on a notifications page

• when snippet is liked
• when a project they're contributing to is added to
• when round is completed/started for a project they're following
• when the round they contributed to is completed
• Add a notifications/activity page

• customize profile picture
• customize username

• Setup a details view controller with a Collection View
• Tapping a cell opens the details view controller
• Setup a reusable Collection View Cell for each snippet
• Load necessary project data in details view controller's collection view (i.e. display snippets-so-far)

• Programmatically setup a custom submissions view controller that appears upon tapping the latest snippet so far
• Retrieve submitted snippets data from Firestore and display in view

• Figure out where the bug is that is causing sign up flow to crash
• Resolve issue
• Make sure users are automatically created with badges
• Clean up design for sign up and login flow
• Make sure there's a loading screen

Overview of vote system

• Votes of users without much karma is worth very little
• Weight of a user's vote is # votes x karma
• If a user votes for multiple snippets in a round then the weight of their vote is divided proportionately by the number of votes the user makes

Issue breakdown

• 1. Prepare client side models and Firestore database to have the necessary data for ranking algorithm to use

  • For now, add a placeholder field for karma in the server side User document, and a placeholder property for karma in the client side User model: everyone starts with 1 karma!
  • Client side Round model has a dictionary of dictionaries called voteData: @{userId : @{voteCount : num of votes made by user, currentKarma : user's karma at time of latest vote}
    --> reason for dictionary of dictionaries design decision: We want to base a user's vote weight on their karma AT the time of the vote, and make it easy for algorithm to retrieve data needed to see how user's karma should be divided proportionately between votes
    • When updating a Snippet's voteCount & userVoted properties, the relevant entry in the Round's dictionary of dictionaries is also updated with the correct numOfVotes. If numOfVotes is 0, remove entry with key 'currUserId' from dictionary.
  • Server side round document has same dictionary of dictionaries
    • When updating the Snippet with votes, also update the Round with numOfVotes

• 2. For MVP, setup a class that directly calculates some basic ranking from the client side to determine which snippet has won using below algorithm (for now, this is only called when a round is being marked as complete):

• 3. Fix any functions involved in choosing the winning snippet to use the round ranking class/methods

• 4. Test!

Algorithm:

• On the round level, use the dictionary of dictionaries to compute another dictionary of @{userId : voteWeight = karma / numOfVotes}
• For each submission, compute score:
  • For each user, add relevant user's voteWeight to totalScore
  • After computing totalScore, add totalScore to a dictionary of @{snippetId : totalScore}
• Go through the dictionary and return an array of snippet ids sorted by score
• Update Firestore with rank & score data

Future improvements (not for MVP)

Change to be a Firebase cloud function that periodically goes through all OPEN rounds and computes score for each snippet in that round:

• Cloud function periodically (every hour?) goes through all OPEN rounds and computes score for each snippet in that round
• For each round that finishes computing score, the cloud function then writes in value for "rank" field and "score" field in each submission for the round
• Deploy cloud function

• Add IQKeyboardManager to fix keyboard covering text view
• Change presentation of ComposeSnippetVC to appear modally from bottom to top
• Add a custom submit button to nav bar

• User can view basic profile information (display name, profile image, etc)
• User can view projects they've created (query all projects under their user id)
• User can see a visualization of their karma/engagement
• User can see progress toward badges/achievements

• Set up system to update karma for user easily

These engagement factors go through a function to generate your karma:

• submit a snippet: +0.1 karma
• voting on a snippet: +0.1 karma
• winning a round: +5.0 karma
  - [ ] viewing projects: 0.01 x user karma (but only up to 100 views)
• compose a starter project: +3.0 karma
• complete a badge: +10.0 karma

Purpose of karma

• Votes of users without much karma is worth very little
• Power of a user's vote is # votes x karma
• If a user votes for multiple snippets in a round then the weight of their vote is divided proportionately by the number of votes the user makes

• Make sure app uses gesture recognizers (e.g. double tap to like, e.g. pinch to scale)

So far, the user's karma and badge only updates property after a submission for the first snippet that a user submits when they open the app. If they submit another snippet, data is not updated on both server and client.

• Understand Google Analytics for Firebase
• Setup core events to track (i.e. project views - how many unique views? how many repeat views?, snippet views, etc.)
• Test that user analytics is tracked properly using Debug View

Option 1: User-defined
- [ ] Users submitting a snippet can mark it as a "final snippet"
- [ ] If a snippet wins and it is a "final snippet", then the Project is considered complete - make rounds immutable except for votes??
- [ ] When voting for snippets, a snippet that is a "final snippet" is clearly marked differently

Option 2: Default value (for MVP, if not enough time)

• For MVP, just add a property to a "Project" model that indicates how many default rounds a Project has before it's considered complete
• When it's the last round, indicate that this is the last round on the submission section!

• Add starter project data to database
• Setup collection view
• Create custom collection view cell to display starter projects
• Retrieve data from database and display in home feed

• Get started with Firebase Security
• Basic Security Rules

• After a certain amount of time (this is added as the properties start and end time in the "Project" object/database, can input this directly for now in the starter data), a round is marked as complete and votes are counted up
• A new round is created if the original latest round was marked as complete
• If no snippets have been submitted when time runs out, then add more time (start timer again)
• Project details page updates with the new round data in a collection view

• Setup Prolific error logging class (see example)

Reference

Description

• Create Firebase project
• Setup Cloud FireStore on Fireboard Console
• Deploy local app to Firebase
• Test deployment

• Setup a submission view controller
• Text submitted by user creates a snippet object
• Snippet object is added to Firestore database

• add a class to control the color scheme of the app
• add custom colors

Handle Firebase iOS Auth Errors

• Add alert for network error
• Add alert for invalid username/passwords
• Add show/hide password functionality
• Remove autocapitalization from text fields

• Setup Favorites view controller with Collection View
• Use same reusable project collection cell from home feed to populate Favorites view controller
• Pull to refresh!

Description

• Initial registration view controller setup
• Setup ability to create basic password-based account using Firebase Authentication SDK