This app will be used to connect to a mat that can measure your jump height.
Contributors:
Calculating jump height from airtime:
height = ((AirTime/2)*(AirTime/2)*0.5*9.81);
Flutter documentation
Project structure
-> fonts/
-> images/
-> models/
-> screens/
-> services/
-> utils/
-> widgets/
-> main.dart
-> routes.dart
Naming conventions
-> File naming
-> Folder naming
-> Class naming
-> Variable/Property naming
--> Private
--> Public
--> Static
Spacing/sizing convetions
Import structure
Pub packages we use
Mandatory plugins for VS code
Handy plugins for VS code
Database
--> Firebase Authentication
--> Firebase Realtime Database
General Data Protection Regulation (GDPR)
A few resources to get you started if this is your first Flutter project:
For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.
lib/
|- fonts/
|- images/
|- models/
|- screens/
|- services/
|- utils/
|- widgets/
|- main.dart
|- routes.dart
A folder to save all our font files in.
Different font families should be added in sub-folders.
More information about font assets and how to use them.
A folder to save all our image files in.
Different categories of images can be structured using sub-folders.
More information about image assets and how to use them.
A folder to save all our class models.
These should all be .dart files, one model = one file.
Inheritance can be used depending on the needs. Clean code guys, ... clean code.
Serializing JSON using code generation libraries
A folder to save all our screens in, a screen is the equivalent to an activity in Android Studio. Every screen is a sub-folder, this sub-folder contains another sub-folder "widgets". This folder is used to create widgets that are only used in this screen. It is possible that these widgets derive from a global widget.
Example:
screens/
|- login
|- login.dart
|- widgets/|- google_button.dart
Another important aspect of a screen is that the root widget of a screen should always be a Scaffold widget which provides basic functionalities like snackbar notifications, ...
More information about the Scaffold widget.
Tutorial about the Scaffold widget.
A folder to save all our services in. An example of a service is one to make http calls to an API or connect to a database.
A folder to save all our utilities in. An example of an utility is a class that converts milliseconds to seconds, showing dates in the proper format...
The utils folder contains the business logic of our application.
A folder to save all our global widgets in.
This is the main entry file of our application and gets executed when the application starts.
The following line run the complete application void main() => runApp(MyApp());.
As a root widget of our app we'll use the MaterialApp widget which will provide a lot of basic functionality like theming, ...
MaterialApp widget documentation.
Tutorial about the MaterialApp widget.
More information about theming.
This file contains should contain a Router class which is responsible for selecting the correct route when the app asks for it.
When a route is requested we must return a MaterialRoute which handles platform specific transitions.
More information about advanced routing in Flutter.
Passing data between screens
navigating through a navigation bottom bar
official flutter navigation documenatation
For the main part we'll use e 8x8 grid. Here are some example sizes: 8, 16, 32, 40, 48, 56, ... For small widgets we can use a 4x4 grid. Material desing sizing specs
To keep our project as clean as possible we all should use the same naming conventions for files and folders as described below.
Files should be named without using capital letters, different word should be connected using an underscore _.
Folders should be named according to the camelCase standard.
Classes should be named according to the PascalCase standard.
Variables or porperties should be named depending in there accessibility.
In Dart private variables always start with an _. As a convention we'll use a lowercase first letter.
int _testNumber
These variables use camelCase.
int testNumber
Should be camelCase with a private static starting with a _.
int testNumber or int _testNumber
When importing classes at the top of our files we will make sure to separate the following using 1 empty line.
- Dart imports
- Flutter imports
- 3th party package imports
- Utils imports
- Services imports
- Models imports
- Screen imports
- Widget imports
*Research needed.
- Firebase Auth
- Google sign in
- Firebase Database
- FL Chart
- Connectivity
- Bluetooth
- Permission handler
- Flutter Markdown
- Jiffy
For the database we use Firebase Authentication and Firebase Realtime Database.
- This is a service that Firebase provides to authenticate Google users to get access to the database. When a user logs on the app for the first time, the app asks if the user wants to accept the terms and policies of the app. Afterwards the user gets added in our FB Auth list with logged on users with a unique Google ID. The extra information will be saved on the FB Realtime DB wich will be explained in the next paragraph.
-
This is another service that Firebase provides to store certain data to the database of your app. You can store integers, strings, floats and so on. To get more structure the data can be stored like a JSON-file. For example:
For our database we have users wich contain user ID's. Those ID's contain their name, the ID of the user and the jumps.Family: Sons: Son1: Name: "Mark" Age: 21 Son2: Name: "Arthur" Age: 16 Daughters: Daughter1: Name: "Emily" Age: 18 Dad: Name: "Michael" Age: 51 Mom: Name: "Sarah" Age: 49
The jumps will have their own unique key once they get added after the user performed a jump on our product. The jump info include the height, date of the jump and probably some future related info that correspond to that jump. This way the app can easily find its way back to the certain jump info that the user requested in the app. We can use variable queries to request our data.
The layout of our database looks like this:
But what about your user security?
This is a very important subject in terms of using a database with personal info. In Firebase we can use security rules wich can be programmed manually on the Firebase Console. We can configure wich data can be accessed and which data is secured. We separate the actions of accessing a database in reading and writing data. But wich info we secure... That's a secret 😉.
GDPR is enforced from May 25th 2018. It is designed to protect user data storage and usage, and to ensure that the user is in control of their data, rather than companies being in charge of user data.
Data Controller: This is the entity that determines the purpose for and means of collecting and processing personal data. If you own a website or mobile app, and you’re deciding what is collected, how it is collected, and for what purpose, you are a Data Controller.
Data Processor: A Data Processor is an organization that processes personal data on behalf of a data controller. For example, third-party services that plug into your website or app, such as Analytics (Google Analytics, KISSMetrics), Cloud Services (AWS), that access or host your customer data.
Data Subject: a natural person whose data is processed. For example, an app user or a website visitor.
A full list of GDPR definitions can be found in Article 4 of the regulation.
- Provide an opt-in screen when the application starts for the first time. It should be possible to decline (if the user declines a pop-up will inform the user that use of this application isn't possible without their consent and will close the app after the user confirms.)
- Opt-in check boxes can't be pre-selected.
- When asking for specific pieces of data, individual options for obtaining consent should be shown.
- Provide an easy way to opt-out in the application settings.
Hi new user! Please read this policy thoroughly before using this application. At Feetback we value your privacy and thus will only use the necessary data for the application to function.
- Google Firebase Data Processing and Security Terms
- Google US data centers
The users data is encrypted in transit using HTTPS. Furthermore the user data is also encrypted at rest.
To keep personal data safe, we employ extensive security measures to minimize access:
- We Restrict access to a select employees who have business purpose to access personal data.
- We log employee access to systems that contain personal data.
- End users Google Authentication token: this token makes it possible for you to log in using your Google account.
- End users name, email.
- Data generated by the end user within the Feetback application.
- The Right to Information
- The Right of Access
- The Right of Rectification
- The Right of Erasure
- The Right to Restriction of Processing
- The Right to Data Portability
- The Right to Object
- The Right to Avoid Automated Decision-Making
The first of the eight rights lies in Articles 13 and 14 of the GDPR. Article 13 refers to information that you must provide when you collect personal data directly from data subjects.
Article 14 covers your responsibilities when you obtain data about the data subject from a third party or indirectly.
Article 13 holds that you must provide the following information when you collect their data (not after).
Article 14 states that you need to provide the same information even if you don't collect the data directly from a data subject but from a third party. A data subject has the right to ask what personal data you collect.
Controller identity and contact details and those of the controller's EU representative (if applicable).
AP Hogeschool
Campus Spoor Noord - Ellermanstraat
Ellermanstraat 33, 2060 Antwerpen, Belgium
onthaal.ell@ap.be
+32 3 220 33 00 (mo-fr 8 a.m. - 6 p.m.)
No DPO is appointed, please contact us using the given contact information.
The data collected is used for educational purposes only.
Belgium, Finland.
Grounds of Legitimate intrests of the processor and third parties.
The data collected is used for educational purposes only.
The data collected is for the purpose of an international project. This project is hosted between AP University College in Belgium and Oulu University of Applied Sciences in Finland. AP University College is the controller of the data, but the data may be sent to the Oulu University of Applied Sciences in Finland.
Oulu University of Applied Sciences
Linnanmaa Campus
Yliopistokatu 9, 90570 Oulu, Finland
international@oamk.fi
020 611 0200 (mo-fr 8 a.m. - 4:15 p.m.)
Any intention to transfer personal data outside the specified processing place and to a third country (particulary if the country is outside the EU).
The data will be stored until you request to delete it or until the project is done. The project ends lastly on january 1st 2021.
As a user you have the right to withdraw consent, you can do this in the application settings.
As a user you have the right to complain about the use of your data. Contact us at onthaal.ell@ap.be. Please refer tho the ICT-electronics department.
There are no contractual requirements to the use of this application.
Existence of profiling and any other types of automated descision-making and information about the logic behind them.
Your data may be used to compare your jumps to the jumps of other users. This is or could become a feature of the application. If you don't want your data to be shared you can specify this in the applications settings.
Article 15 outlines the first named right found in the GDPR: The right to access. This means that the data subject may access the personal data belonging to them.
As a user you have the right to ask why and how your data is processed, categories of personal data involved, who sees the data (including countries outside the EU), how long your data is stored, how to exercise your rights, source of the data collected about you and wether we use automated descision-making. You may request a copy of your personal information once each month without any fees. You also may ask us to limit the use of your personal data or even delete it.
You also have the right to complain to the Belgian privacy regulator should you feel your rights or the law has been compromised.
- Send us an email at onthaal.ell@ap.be
- Use subject: "Request for personal data"
- Refer to the ICT-electronics department.
- Specify what data you would want to recieve.
- We'll get into touch in 48 hours.
Article 16, the right to rectification, provides European data subjects with the right to change or modify the data they provide you when they believe the data is inaccurate or out-of-date. You need to provide this "without undue delay." Why is holding accurate data so important for you and your data subjects? Because incorrect data threatens the privacy of other individuals.
For example, if you hold data subject phone numbers, you need to acknowledge that people change their phone numbers from time to time. If you hold old phone numbers that were then given away to new customers, you risk contacting a customer who didn't provide consent.
Holding data and contacting customers without their consent is a GDPR violation.
As a user you have the right to adjust inaccurate or ou-of-date data. This can be done in the application settings.
Article 17 describes the user right to erasure, which is better known as the right to be forgotten. When you make the decision to erase a data subject's data according to the right to erasure, you also need to share the request. All other controllers or processors with whom you have a contract also need to be aware of the erasure so that they can also erase:
- Links to ...
- Copies of...
- Replication of personal data
As a user you have the right to request deletion of your data. You can do this by deleting your account in the application settings.
Article 18 outlines the data subject's right to request the restriction of processing under certain conditions. That means you must temporarily stop processing their data as requested as long as their requests meets one of the following:
- The data subject contests the accuracy of the data
- The data subject objects to unlawful processing and the data subject prefers you to restrict the processing rather than erasing their data
- The data controller does not need the data for processing but they need to keep the data pursuant to the "establishment, exercise, or defence of a legal claim" Article 18(3) states that if you temporarily stop processing data, then you must inform the data subject before lifting the restriction and resuming the processing, if you choose to do so.
The right to data portability outlined in Article 20 refers to the data subject's right to receive the personal data held by the data controller in a commonly used format and send the data to another controller or use it for their personal purposes, under certain circumstances.
As a user you have the right to recieve your personal data in a structured, machine readable and safe way.
Article 21 outlines what is known as the right to object. In simple terms, it says that data subjects have the right to object to your data processing, including profiling, when it is on relevant grounds.
As a user you have the right to object the use of your personal data, at any stage. You also have the right to object to out using of your personal data where our reason is based on legitimate intrests. We will have to stop processing until we can establish that we have compelling legitimate grounds which override your intrests, rights and freedoms, or that we need to continue using it for the establishment, exercise, or defense of legal claims.
The eighth and final right offered by the GDPR lies in Article 22: Automated decision-making, including profiling. It says: "The data subject shall have the right not to be subject to a decision based solely on automated processing, including profiling, which produces legal effects concerning him or her or similarly affects him or her".
As a user you have the right to decline automated decision-making, there are three exception though:
- When automated decision-making is necessary to enter into or complete a contract.
- When we have the authorization from the EU or a Member State and uses safeguards to protect the subject's interests and freedom.
- When you give explicit consent. We don't use automated descision makeing so don't worry.