Software Quality and Reliability S23 course

Semester 8, 4th study-year, Innopolis University.

Team

• Emil Khabibullin
• Timur Nugaev
• Roman Soldatov
• Daniil Livitin
• Mikhail Martovitsky

📌 About

• This application can be used to track household chores for roommates.
• A user can create a queue and invite his/her roommates.
• Users complete a queue task one by one in a loop. So, ideally, every roommate should complete a task on each iteration.
• The app helps to remind users about to-dos and fairly automate the tasks distribution between roommates based on their contribution.
• For the REST API, the Backend project was developed.
• SonarQube analysis

📲 APK

• You can download the APK file to install and use it on your Android phone. Available on the GitHub releases page
• or you can download this GitHub project and build it for your favourite platform 🙃.

☎️ iOS

• For iOS, you can download this GitHub project and build it by yourself.

🛠 How to build

• When you've cloned the repo, you'll need to run flutter pub get to locally install all the dependencies
• Wait a bit...
• To release build APK for android run: flutter build apk --split-per-abi
• To release build for iOS run: flutter build ios
• PROFIT

🖥 List of screens

Onboarding screen

• Input user name

To-do tasks

• To-do tasks section
• Select several tasks

Queues

• Queues section
• Create queue
• Join queue
• Queue's details
• Edit queue
• Invite in queue

Notifications

• Notifications section
• push notifications on Android

Settings

• Settings section
• Notification settings
• Theme
• Language

🕹 List of features

• Create a new queue
• Invite users to a queue
• Complete a task when it's your turn
• Complete a task even it's not your turn. So, you will be skipped on the next iteration
• Skip a task. However, on the next iteration, you will be forced to complete a task twice
• Track expenses for tasks that require buying something
• Temporarily leave a queue ("freeze"). Your progress will be saved, but you won't participate in a queue. For example, you can use this feature when you leave your room for the Winter holidays
• If it's someone's turn you can "shake" him to remind him about a task by sending a notification
• Receive reminders when it's your turn
• Receive notifications about queue progress
• Notifications history
• No registration is needed

Features on which we are working on can be found in issues

📚 Contribution

If you have any ideas on how to imporove the quality of our product or of the quality ensurance for our project, we welcome your enthusiasm and here's how you can contribute!

In short:

• Fork this repo
• Create a new issue in our repo, where you describe what contribution you want to make thoroughly
• Assign the correct labels to the issue [*]
• Create a new branch using appropriate naming conventions [**]
• Make the necessary changes
• Push the changes to your repo
• Make a pull request from your repo on your branch to our repo's main branch
• Don't forget to add a comprehensive description so we understand better what you did
• We're going to review your changes and decide on whether to accept your code [***]

[*] Issue labels:

• routine is for routine tasks like quality ensurance. the code under this tag should not add any new functionality application-wise. for example: rework database schemas
• feature is for tasks that add new functionality, features, etc. for example: add pagination
• bug is for bugfixes.

Note: we do not accept any other labels for contribution issues

[**] Branch naming:

• If it's a feature you're adding, name your branch feature/task-title
• If it's a routine task, name your branch routine/task-title
• If it's a bug fix, name your branch fix/task-title

[***] Code review may take up to 2 working days

Code style

Is described in details here

📊 Repositories

• The README repository
• The Backend REST API project which mobile application uses is in this repository