jaap/wellbeingapp
1
0
Fork 0
mirror of https://github.com/hobbesjaap/wellbeingapp.git synced 2024-11-22 02:22:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

updated README file

Browse Source
This commit is contained in:
Jaap Marsman 2022-08-17 09:14:58 +08:00
parent 9d71295ff3
commit 636d5718fa
4 changed files with 32 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -6,23 +6,32 @@ A freeware and open source wellbeing app.
This app is being developed, researched and released using the following guiding principles:
1. **Research-informed**: Wherever possible, any intervention or activity suggested by the app will be supported by academic research. An up-to-date list of academic references (APA style) will be kept within the app with a very brief description on what segment of the app it informed. A more detailed breakdown may appear on my private website, at some point.
1. **Research-informed**: Wherever possible, any intervention or activity suggested by the app will be supported by academic research. An up-to-date list of academic references (APA style) will be kept within the app with a very brief description on what segment of the app it informed. A more detailed breakdown may appear on my private website, or here, at some point.
2. **Agile practises**: I will try to adopt agile coding practises as I go through. This means I aim to release useful features as soon as possible and reiterate, refactor and improve based on feedback. Using the in-app feedback button to let me know how things work for you is therefore the best way to gather this information at this stage.
3. **Free, Open Source**: Inspired by the likes of the NOBA project, the Linux community and countless other highly successful Free, Open Source Software (FOSS) projects out there, my aim is to offer a wide-ranging wellbeing tool available for free to anyone who seeks to use this. The only exception may be future iOS versions, due to the requirement for a paid Developer account with Apple. Even then, this version will be available for a fixed cost, not based on a subscription model.
4. **Potentially informing my own research**: This guiding principle may develop into something cohesive or fall away completely. I am currently a student at Glasgow University, completing my Master's in Science in Psychology (online conversion). Depending on how successful I am with developing this project, I may end up designing a research project around it to inform my dissertation / thesis. This is an idea I'm toying with. If this pans out, the research project will run separate from this app, but I will seek volunteers to gather anonymous usage data from. I will not build *any* telemetry into this app. Ever. Any sampling and data collection will run through a separate platform (something like LimeSurvey or SurveyMonkey).
3. **Free, Open Source**: Inspired by the likes of the NOBA project, the Linux community and countless other highly successful Free, Open Source Software (FOSS) projects out there, my aim is to offer a wide-ranging wellbeing tool available for free to anyone who seeks to use this. The only exception may be future iOS versions, due to the requirement for a paid Developer account with Apple. This will depend on any changes in my personal financial situation.
4. **Potentially informing my own research**: This guiding principle may develop into something cohesive or fall away completely. I am currently a student at Glasgow University, completing my Master's in Science in Psychology (online conversion). Depending on how successful I am with developing this project, I may end up designing a research project around it to inform my dissertation / thesis. This is an idea I'm toying with. If this pans out, the research project will run separate from this app, but I will seek volunteers to gather anonymous usage data from. I will not build *any* telemetry into this app. Ever. Any sampling and data collection will run through a separate platform (most likely LimeSurvey).
## Psychological Principles and Criteria (rough draft)
## Psychological Principles, Definitions and Criteria
Perhaps equally as important here are the psychological principles guiding decisions around what to include in this app.
Equally important are the psychological principles guiding decisions around what to include in this app. Since many concepts have varying definitions I will keep an overview here.
1. Research-informed. Define what this means.
2. Definition of wellbeing. Not as a state or fixed endpoint. But similar to work life balance, as something we must always strive to maintain.
3. The concept of a psychologically rich life, as defined by …
1. All activities and interventions available in the app will be *research-informed*. As explained by Ashman (2018), it is noted where evidence exists and where it does not, with decisions made accordingly. This approach acknowledges that, even where evidence exists, it may have other considerations, e.g. a very small number of participants or participants from a similar background or ethnicity.
2. There is no conclusive definition of *wellbeing*. For the purposes of this app, wellbeing is seen not as a state or fixed endpoint. Similar to work-life balance, it is seen as something we must always strive to maintain. A number of *self-care* interventions can assist with this balancing.
3. The concept of a psychologically rich life, as defined by Oishi & Westgate (2022) which states three related, but distinct aspects of a good life: happiness, meaning and psychological richness.
## Development Journals
## Development Logs
My aim is to write a development journal (or potentially record one on YouTube now and again) whenever I have something meaningful to say. For example, questions like "Why Godot?" or "C# and GDScript? Tell us more..." are questions I will aim to answer there.
My aim is to write a development log (or potentially record one on YouTube now and again) whenever I have something meaningful to say. These are hosted on my personal blog. Links to these dev logs are listed below, for easy reference.
## License
- <a href="https://www.jaapmarsman.com/post/2022-08-10-devlog-one/" target="_blank">DevLog #1</a>
<a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/4.0/" target="_blank"><img alt="Creative Commons Licence" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-nd/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/4.0/" target="_blank">Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License</a>.
## License & Attributions
<a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/4.0/" target="_blank"><img alt="Creative Commons Licence" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-nd/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/4.0/" target="_blank">Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License</a>.
For an overview of all licences and attributions, please see the [License document](LICENSE.md).
## References
Ashman, G. (2018). The truth about teaching: An evidence-informed guide for new teachers. SAGE.
Oishi, S., & Westgate, E. C. (2022). A psychologically rich life: Beyond happiness and meaning. Psychological Review, 129(4), 790–811. [https://doi.org/10.1037/rev0000317](https://doi.org/10.1037/rev0000317)

2
godot/project.godot
View File

@ -28,7 +28,7 @@ window/size/width=1280
window/size/height=720
window/energy_saving/keep_screen_on=false
window/stretch/mode="2d"
window/stretch/aspect="expand"
window/stretch/aspect="keep_width"
[gui]

6
godot/start_menu.tscn
View File

@ -81,7 +81,7 @@ margin_left = -185.0
margin_top = 11.0
margin_right = 185.0
margin_bottom = 42.0
text = "Poofaces are cool"
text = "All your base are belong to us"
[node name="HTTPRequest" type="HTTPRequest" parent="."]
@ -89,9 +89,9 @@ text = "Poofaces are cool"
anchor_top = 1.0
anchor_bottom = 1.0
margin_left = 5.0
margin_top = -25.0
margin_top = -29.0
margin_right = 1280.0
margin_bottom = 5.0
margin_bottom = 1.0
text = "Version"
[connection signal="pressed" from="MarginContainer/GridContainer/button_open_github" to="MarginContainer/GridContainer/button_open_github" method="_on_button_open_github_pressed"]

10
godot/start_screen.tscn
View File

@ -40,11 +40,15 @@ margin_right = 1280.0
[node name="start_menu" parent="UI/top_container/menus_container" instance=ExtResource( 3 )]
[node name="user_details" parent="UI/top_container/menus_container" instance=ExtResource( 2 )]
visible = false
[node name="daily_prompts" parent="UI/top_container/menus_container" instance=ExtResource( 4 )]
visible = false
[node name="bottom_bar" type="Panel" parent="UI"]
margin_top = 680.0
margin_right = 1280.0
margin_bottom = 720.0
anchor_top = 1.0
anchor_right = 1.0
anchor_bottom = 1.0
margin_top = -40.0
rect_min_size = Vector2( 0, 40 )
custom_styles/panel = SubResource( 2 )