README.md

WakeMeApp

⚠️WIP

Index

• Overview
• Objective
• Target
• Features
• Specification
• Architecture
• Data Architecture
• Contributor
  • UI design
• Note

Overview

WakeMeApp is the app for those who are often late for school, work, and anywhere you should arrive early or on time.
This app helps you wake up on time and be able to check if your friends are awake or oversleeping.
NEVER let anyone call you a SLEEPY HEAD!

Designed by Natsumi Kobayashi
👉 Go to see details 👀

Objective

• Help users wake up on time.
• Show the sleep status depending on the set wake up time, and update it with the last-seen time.
• Allow users to send a message right after checking if his/her friends overslept.

Target

• People who often sleep over
• People who often text their friends about their attendance.

Features

• Set an alarm.
• Share the time you want to wake up.
• Send a notification after the time to check if the user is awake.
• Show the status if the user oversleeps.
• Show friend list in order of sleep status, with oversleeping friends listed first.
• Send and receive messages to friends.
• Store all messages.
• Track the last-seen status.
• Create an account with Email and Password.
• Facebook login.
• Configure your profile. (Name/ Email/ Password)
• Upload a profile picture from a device.
• Search for friends by Email.
• Send a notification to a backgrounded app when it gets a new message.
• Reset a password.

Specification

Language:

• Java
• JavaScript

Libraries:

• Android Support Library
• Picasso
• Glide
• CircleImageView
• Firebase
  • Authentication
  • Cloud Storage
  • Realtime Database
  • Cloud Functions
  • Cloud Messaging
  • Crashlytics

Test Tool:

• Monkey

Architecture

✏️ TBA

Data Architecture

Firebase

* UID == Firebase Authentication user UID

root
  ├ Receivers
  |  └ {UID}
  |     └ {chatRoomId}
  |         ├ notifications
  |         |  └ {pushId}
  |         |      |[Notification object]
  |         |      ├ id (== pushId)
  |         |      ├ topic
  |         |      ├ title
  |         |      └ body
  |         |
  |         └ receiver: [User object] *See a 'Users' reference below.
  |
  ├ ChatRooms
  |  └ {chatRoomId}
  |     |[ChatRoom object]
  |     ├ id (== chatRoomId)
  |     └ memberList
  |
  ├ FriendIDList
  |  └ {UID}
  |     └ {UID}: true
  |
  ├ Messages
  |  └ {chatRoomId}
  |     └ {pushId}
  |        |[Message object]
  |        ├ id (== pushId)
  |        ├ text
  |        ├ senderId
  |        ├ createdAt
  |        └ isSeen
  |
  ├ ReceiverPaths
  |  └ {UID}
  |     └ {chatRoomId}: "xxxxxxxxxxxx"
  |
  └ Users
     └ {UID}
         |[User object]
         ├ id (== UID)
         ├ name
         ├ icon
         ├ email
         ├ lastLogin
         └ wakeUpTime
             |[WakeUpTime object]
             ├ alarmOn
             ├ repeatModeOn
             ├ mon
             ├ tue
             ├ wed
             ├ thu
             ├ fri
             ├ sat
             ├ sun
             ├ hourOfDay
             ├ minute
             └ wakeUpTimeInMillis

Contributor

Designer: Natsumi Kobayashi

UI Design

Click to see a larger image.

Thank you @Natsumi for designing all layouts of WakeMeApp. The design is really well-organized, user-friendly, and beautiful.
When I first told you the idea, you immediately understood the concepts and gave me a lot of advice as a designer. Whenever I asked you for additional design work, you were always flexible and dealt with my requests. Thank you so much for your help, and please let me know if I can return the favor!

Note

⚠️The google-services.json from Firebase which is necessary to run this app is not included in this repository for security reasons.

This app is a WIP.