App Planning Document
- Franco Reyes (Unlicensed)
- Bob Chen (Unlicensed)
This document includes:
Detailed project plan outlining the specific stages of development and corresponding timelines for completion
A technical specification document outlining the app's architecture, technology stack, and infrastructure requirements
A detailed testing and quality assurance plan, including both manual and automated testing
A plan for post-launch maintenance and updates, including bug fixes and new feature releases
A clear communication plan for regular updates and progress reports
A plan for data and user privacy, compliance with regulations and standards
A plan for security, including measures to protect user data and the app itself from unauthorised access or attacks
The number of developers who will be working on the app so that we can provision the correct number of certificates and check costing
Development Stages
Stage | Goal | Details |
|---|---|---|
A | Boilerplate project | Create a simple single page app which builds and is preview-able on a phone. |
B | Implement Browse Buildings Page | Replicate the function of the browse page on the Freerooms website, showing buildings and allowing for the selection of a building to then view rooms inside it. |
C | Implement Individual Room Pages | Replicate the function of the individual room information page which contains the calendar of a page’s booking. |
D | Implement Map | Replicate the function of the map on the Freerooms website. |
E | Implement Search Page | Implement a page to search for buildings and rooms. |
F | Implement Favouriting of Rooms | Implement a way to save favorited rooms. |
G | Implement Home page | Design and implement a landing or home page which can direct users to the different functions and views of the app |
H | Submit MVP for App Store Approval |
|
Tech Stack and Infrastructure
The app will be written in React Native on the Expo framework. Expo will handle the build and packaging for App Store deployment on both iOS and Android platforms. Expo is also the only way to develop for iOS using a Windows device which certain members of the Freerooms team use.
Should Expo become unsuitable for any unforeseen costing reasons, it is still reasonably easy to convert the project to pure React Native - built with Xcode.
The app will rely on existing endpoints and routes on the v2 backend which as been used for the Freerooms website.
Testing
The following automated tests will be part of our CI pipeline:
Linting and static type analysis via Typescript
Unit tests for any calculation functions via Jest
Component testing for key components via Jest and React Native Testing Library
Integration testing via Detox
We will also perform manual usability testing on iOS and Android devices.
Updates and Maintenance
Development of the App will progress per the goals and features determined by each set of project directors. As updates and features are pushed to the master branch and deployed, app features will be pushed to the master branch and aggregated. Once sufficient, an update to apps will be pushed.
We will also establish a method for users to provide feedback, allowing us to respond to issues quickly.
Progress Reporting
We will provide updates on the development on the app in the monthly director meetings as we have already been for the website.
Regulatory and Privacy
Data Collection
Key:
⛔️ No plans to collect [22]
❇️ May collect in a later version of the app [10]
✅ Will collect in the first version of the app [0]
Contact Info | ||
|---|---|---|
Name | Such as first or last name | ❇️ |
Email Address | Including but not limited to a hashed email address | ❇️ |
Phone Number | Including but not limited to a hashed phone number | ❇️ |
Physical Address | Such as home address, physical address, or mailing address | ⛔️ |
Other User Contact Info | Any other information that can be used to contact the user outside the app | ⛔️ |
Health & Fitness | ||
Health | Health and medical data, including but not limited to data from the Clinical Health Records API, HealthKit API, MovementDisorderAPIs, or health-related human subject research or any other user provided health or medical data | ⛔️ |
Fitness | Fitness and exercise data, including but not limited to the Motion and Fitness API | ⛔️ |
Financial Info | ||
Payment Info | Such as form of payment, payment card number, or bank account number. If your app uses a payment service, the payment information is entered outside your app, and you as the developer never have access to the payment information, it is not collected and does not need to be disclosed. | ⛔️ |
Credit Info | Such as credit score | ⛔️ |
Other Financial Info | Such as salary, income, assets, debts, or any other financial information | ⛔️ |
Location | ||
Precise Location | Information that describes the location of a user or device with the same or greater resolution as a latitude and longitude with three or more decimal places | ❇️ |
Coarse Location | Information that describes the location of a user or device with lower resolution than a latitude and longitude with three or more decimal places, such as Approximate Location Services | ❇️ |
Sensitive Info | ||
Sensitive Info | Such as racial or ethnic data, sexual orientation, pregnancy or childbirth information, disability, religious or philosophical beliefs, trade union membership, political opinion, genetic information, or biometric data | ⛔️ |
Contacts | ||
Contacts | Such as a list of contacts in the user’s phone, address book, or social graph | ⛔️ |
User Content | ||
Emails or Text Messages | Including subject line, sender, recipients, and contents of the email or message | ⛔️ |
Photos or Videos | The user’s photos or videos | ⛔️ |
Audio Data | The user’s voice or sound recordings | ⛔️ |
Gameplay Content | Such as saved games, multiplayer matching or gameplay logic, or user-generated content in-game | ⛔️ |
Customer Support | Data generated by the user during a customer support request | ⛔️ |
Other User Content | Any other user-generated content | ⛔️ |
Browsing History | ||
Browsing History | Information about content the user has viewed that is not part of the app, such as websites | ⛔️ |
Search History | ||
Search History | Information about searches performed in the app | ❇️ |
Identifiers | ||
User ID | Such as screen name, handle, account ID, assigned user ID, customer number, or other user- or account-level ID that can be used to identify a particular user or account | ⛔️ |
Device ID | Such as the device’s advertising identifier, or other device-level ID | ⛔️ |
Purchases | ||
Purchase History | An account’s or individual’s purchases or purchase tendencies | ⛔️ |
Usage Data | ||
Product Interaction | Such as app launches, taps, clicks, scrolling information, music listening data, video views, saved place in a game, video, or song, or other information about how the user interacts with the app | ❇️ |
Advertising Data | Such as information about the advertisements the user has seen | ⛔️ |
Other Usage Data | Any other data about user activity in the app | ⛔️ |
Diagnostics | ||
Crash Data | Such as crash logs | ❇️ |
Performance Data | Such as launch time, hang rate, or energy use | ❇️ |
Other Diagnostic Data | Any other data collected for the purposes of measuring technical diagnostics related to the app | ❇️ |
Other Data | ||
Other Data Types | Any other data types not mentioned | ⛔️ |
Security
As stated above we aren’t handling any secure user data, the app is primarily an interface to our database. Regardless, we will:
Ensure that the app is regularly updated with the latest security patches and updates to address any known vulnerabilities.
Validate all user input to prevent malicious requests from being sent to the server
Developer Resource Provisioning
Both Freerooms Directors will have access and permissions to and oversight over the app source code.
Subcommittee groups will also be given tickets and tasks to work on. Per 2023 Freerooms practice, subcommittee members are paired together for tasks. Hence, 2 subcommittee will begin working on the app with 2 more to join as progress is made on the existing Frontend and Backend tasks.