omarbakker/stream-app

Stream

We are an Android application aimed to help students work efficiently and effectively in group projects.

Team Members

1. Kevin Wong
2. Robyn Castro
3. Catherine Lee
4. Omar Mohammed
5. Rohini Goyal
6. Jane MacGillivray
7. Xingyu Tao

User Manual

• User manual is available at https://github.com/omarbakker/Stream-app/blob/master/docs/Dec%202%20Deadline/STREAM_UserManual.pdf

How to find Documents

• Documents can be found at https://github.com/omarbakker/Stream-app/tree/master/docs

Issues with the application

• Bugs are listed under Issues tab on GitHub

Developer Section

How to find source code

• All source code is located in the directory app/src/main: https://github.com/omarbakker/Stream-app/tree/master/app/src/main/

How to check out source code and run project

1. Install Android Studio on the computer
2. Set up Emulator or have an Android Device
3. Clone the repository from GitHub by: git clone https://github.com/omarbakker/Stream-app on Terminal/ Git Bash
4. Open the project on Android Studio and wait for Gradle to sync
5. Run the Android app on emulator or plug in Android Device and run app on device by clicking the Run button (green play button). All dependencies are handled by Gradle and the application can be run straight from cloning this repository

How to run tests

1. Clone the repo from GitHub by: git clone https://github.com/omarbakker/Stream-app on Terminal/ Git Bash
2. On Terminal or Git Bash type in the command git fetch --all to get all branches of the repository
3. Open the project on Android Studio and wait for Gradle to sync
4. Go to directory app/src/androidTest/java/com/test/stream/stream to see all Unit Tests
5. Open the Unit Test file e.g. ProjectsTest.java
6. Right click on the class name and click Run. For instance if you are trying to run ProjectsTest.java right click ProjectsTest and click "Run ProjectsTest"
7. Note that UserTests must be run separately from other tests to pass.

Structure of source code directory

• app/src/main/assets folder includes all fonts used for the project
• AndroidManifest.xml contains settings for the project such as listing all Activities and Fragments as well as themes
• app/src/main/res folder contains all images used in the application. Images will be stored on drawable or mipmap folder
• app/src/main/res/layout folder contains all the xml files for the application. These xml files are inflated to display the UI of the application such as PinBoard, Tasks, Projects, etc
• app/src/main/java/com/test/stream/stream/Controllers contains all the Java files to interact with Firebase
• app/src/main/java/com/test/stream/stream/Objects contains all the object declarations of the project. For instance, PinMessage will have string properties to store title, color and description. These objects will make it easier to store data into the database.
• app/src/main/java/com/test/stream/stream/UI contains all the activities of our application. These activities display all the UI such as buttons, lists, popup dialogs and many more so that the users can interact with the application
• app/src/main/java/com/test/stream/stream/UIFragments contains all the fragments for navigation when clicking on the specified button on the toolbar
• app/src/main/java/com/test/stream/stream/Utilities contains all the enums, callbacks and general database helper functions for the application

Design Patterns used

• We are using the Singleton design pattern for the database Managers (BoardManager, CalendaManager, DataManager, ProjectManager, TaskManager, UserManager) because there are a lot of dependencies with the data in the database. Since we want to be able to access objects while browsing through the application, we applied the Singleton design pattern to these classes.

stream-app's Issues

Create New Meeting window doesn't close properly

Create new meeting window pops up again when you browse to the projects screen after it returns to the calendar.

Medium: Log out is missing

Users cannot log out from their account

Medium: Inputting too many characters inside input boxes causes overflow on the GUI.

HIGH: Send notification and Edit task both display when either is clicked.

Medium: Home screen opens to be scrolled to the bottom

Medium: Tasks are not being marked as complete

Tasks marked as complete are not saved.

HIGH: Home Page Team Progress Incorrect

HIGH: User creation is faulty when an already used email is used

A new user is sent directly to the projects home screen without a project. Then, when the user browses, they're sent back to the user creation page.

Medium: New Objects can added before object listeners are initialized

The option to add tasks, pins, calendar, etc. should be disabled until listeners are initialized sucessfully.

High: Calendar Screen Results in a Crash

Navigating to the calendar screen causes a crash.

Medium: Days to due does not display properly on tasks and home page.

HIGH: username not being created by Usermanager on email signup

Create task dialog should close keyboard after clicking add member and not jump cursor back to title

Medium: Include info text when there's no projects/tasks/meetings/pins

High: Tasks UI fails to Load after Browsing

Steps to reproduce:

1. Enter a project
2. View tasks (maybe create tasks too)
3. View pin board
4. View tasks again and note that no tasks are appearing

Medium: Invalid error message for dialogues has to be erased.

Medium: Expand task activity task description goes behind the buttons.

HIGH: Home Page Edit Task Does Not Work

HIGH: Pressing the device back button on Projects Activity takes you back to the Projects Activity.

High: Switching between projects is not correctly updated

Tasks and other objects are not getting updated when a user changes their current project. We need to destroy other components of the project and reload them when a project is changed.

HIGH: Switching Between Users is not correctly updated

Logging out and logging into a new user shows the previous user's projects.

Sign Up Screen doesn't close properly

If you create a user through sign up screen, browse into a project, then return to the projects page, you'll find that sign up screen appears

HIGH: Cannot assign tasks to newly added users.

HIGH: Adding users to projects does not add the project to them

When users are added to projects, users other than the creator do not see the project.

HIGH: Switching users does not update the project list.

Medium: Account creation gives incorrect email in use message

When a new user signs up sometimes the error message "Email address is already in use" pops up even if it's a unique email address.

High: Tasks UI is Broken

When creating new tasks, no new task is created in the database.

Steps to reproduce:

1. Log into Stream
2. Enter a project
3. Enter the tasks screen
4. Create a sample task
5. Observe that the new task is not created under tasks in the database, nor is it added to the current project's Task Group.

Medium: Facebook login lags when switching to projects page

When you click "login with facebook" the MainLoginScreen UI updates first. The facebook login button changes to say "Log Out" and then the UI changes to the projects page

Medium: Going from toolbar activity to projects activity does not refresh projects activity.

Medium: Users not in a Project can be assigned a Task

Users not in a project can be assigned a task so long as they are a user of Stream

High: Implement Sign up with Facebook on the signUpScreen

HIGH: Projects page needs refresh functionality.

High: Pins do not correspond to project

Pins in the project depend on a test board id, instead of the current project.

HIGH: Tasks aren't properly updated upon changing projects

How to reproduce:

1. Enter a project
2. Observe that the project home page reflects the project tasks
3. Enter another project
4. The previous project's tasks may be incorrectly displayed

HIGH: Team page overflow causes add member portion to be hidden.

HIGH: Pins cannot be edited or deleted.

Low: Floating action buttons don't have the same screen position.

Medium: Sign in with facebook opens up two ProjectsActivities

Sign up works so we when looking for fix, maybe look at that?

HIGH: Signing up with facebook causes project navigation to stop working.

Sign up with facebook. Enter a project. Go back to projects list. It will take you to the SignUpScreen instead

Medium: Send notification button on expanded task does not work and display properly

Low: PinBoard should not show empty strings

Add a check in PinMessage creation to eliminate empty strings for PinMessage titles, subtitles and description.

HIGH: Calendar edit meeting does not work.

Medium: Tasks is only assigned to the logged in user

Tasks are not being correctly assigned to other members on the team yet.

LOW: First time going to home from projects list does not shade in the menu properly.

Medium: User is not updated real times

If modifications are made the Current User by other Team Member (ie. assigned tasks), the user is not updated.

HIGH: Home page add add task does not work.

Low: Members are mispelled in projects

Members are written as "memebers" in projects page.

Low - App crashes without username and password when clicking login

On the Login screen of STREAM, when clicking Login button without email and password fields inputted, app breaks.

Medium: Homepage GUI color scheme needs fixing

HIGH: Creating Users with Email cannot be logged into later

Creating a user with an email successfully takes you to projects. However, when you log in as the same user later, the error message "invalid login" is always provided.