https://github.com/filledstacks/startup_bounty
Bounty for some startup logic
https://github.com/filledstacks/startup_bounty
Last synced: 6 months ago
JSON representation
Bounty for some startup logic
- Host: GitHub
- URL: https://github.com/filledstacks/startup_bounty
- Owner: FilledStacks
- Created: 2024-01-23T10:57:38.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-24T13:00:16.000Z (almost 2 years ago)
- Last Synced: 2025-04-16T06:43:47.457Z (9 months ago)
- Language: C++
- Size: 296 KB
- Stars: 4
- Watchers: 3
- Forks: 19
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Startup Bounty (Collected)
---
The bounty has been collected and the functionality has been merged. Thanks to everyone that submitted a PR.
---
I need to read a value from disk, and I haven't been able to do that.
The value has to be read from disk in the `main` function, before calling `WidgetsFlutterBinding.ensureInitialized()`.
If you can implement this functionality I will send you $100 USD
## Requirements
- If you write the data to a file, the path has to come from the official documents directory for the platform it's running on
- You can't use a backend solutions
## Submission
Submit a PR with your solution along with an explanation of what you did and how it works.
## How paths are determined?
### Web
- Config are stored in localstorage of website in the browser using dart's window.localstorage https://api.dart.dev/stable/3.2.5/dart-html/Window/localStorage.html API.
- For the web, it is https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage in javascript.
## Android
- Android official APIs provide `/data/user//` as the application's storage directory.
- This path isn't mentioned in the API's documentation at https://developer.android.com/training/data-storage but mentioned in the Device paths section of Testing Multiple Users for app storage https://source.android.com/docs/devices/admin/multi-user-testing#device-paths
- The `Directory.systemTemp` returns a cache path `code_cache/` inside the app's storage directory. I return the `files/` directory inside the parent directory of the systemTemp path to be used as app's data document directory.
- The `files/` directory inside of app's data directory (storage directory) is returned for storing config files like how path_provider gets data files directory from flutter PathUtil java https://github.com/flutter/engine/blob/57d6b518f9205027256391e3c71529ee510598cf/shell/platform/android/io/flutter/util/PathUtils.java#L17
## iOS & MacOS
- Right now, we get app's app container path by taking the parent path from the path of `Directory.systemTemp`. The `/Documents` directory inside is the platform's document directory for this application.
- Reference: https://developer.apple.com/library/archive/documentation/FileManagement/Conceptual/FileSystemProgrammingGuide/FileSystemOverview/FileSystemOverview.html & https://cocoacasts.com/fm-1-how-to-get-documents-directory-in-swift
## Windows
- Created a directory for storing app's data in the directory path received from environment variable `LOCALAPPDATA`.
- The app directory is created using app's provided package name. for example, when app's package name is `com.example.app`, the directory name will be `com.example/app`.
- For storing app config for a user, windows had in the reference document to use the env variable APPDATA or LOCALAPPDATA. Reference: Reference: https://web.archive.org/web/20120905053951/http://download.microsoft.com/download/e/6/a/e6aa654f-cccb-421e-9b50-3392e9886084/VistaFileSysNamespaces.pdf
## What's a more reliable solution?
Getting these path from platform's official APIs.
1. One way to do this is to use method channels from flutter to communicate with platform code but doing this will be breaking the requirement for this task.
2. We could build our own way to communicate from dart to platform code without using flutter. I will need to research to say more about how this approach can be taken to solve this problem reliably.