marcoXbresciani / TKCompanionApp

A short and small helper for Toyota Kata practitioners - If you're reading this here on GitHub, please note that main repository is now Codeberg: https://codeberg.org/marco.bresciani/TKCompanionApp
GNU General Public License v3.0
3 stars 1 forks source link

© 2021-2024 Marco Bresciani

Copying and distribution of this file, with or without modification,

are permitted in any medium without royalty provided the copyright

notice and this notice are preserved.

This file is offered as-is, without any warranty.

This is a freely licensed work, as explained in the Definition of Free

Cultural Works.

SPDX-FileCopyrightText: 2021-2024 Marco Bresciani

SPDX-License-Identifier: CC-BY-SA-4.0

+AUTHOR: Marco Bresciani

+LANGUAGE: en

+OPTIONS: toc:nil

+TITLE: TKCompanionApp

-- mode: org; coding: utf-8-dos; --

[[https://codeberg.org/marcoXbresciani/TKCompanionApp/src/branch/master/COPYING][https://img.shields.io/github/license/marcoxbresciani/tkcompanionapp.svg?logo=gnu]] [[https://codeberg.org/marcoXbresciani/TKCompanionApp/][https://img.shields.io/badge/hosted%20on-codeberg-2185D0.svg?logo=codeberg]] [[https://codeberg.org/marcoXbresciani/TKCompanionApp/src/tag/7.0.0][https://img.shields.io/github/v/tag/marcoXbresciani/TKCompanionApp.svg?color=black&logo=codeberg&sort=semver]] [[https://img.shields.io/github/downloads/marcoXbresciani/TKCompanionApp/total.svg?logo=github]] [[https://f-droid.org/en/packages/name.bresciani.marco.tkcompanionapp/][https://img.shields.io/f-droid/v/name.bresciani.marco.tkcompanionapp.svg?logo=fdroid]] [[https://github.com/standard/ts-standard][https://badgen.net/badge/code%20style/ts-standard/blue.svg?icon=typescript]]

[[https://api.reuse.software/info/codeberg.org/marcoXbresciani/TKCompanionApp][https://api.reuse.software/badge/codeberg.org/marcoXbresciani/TKCompanionApp]]

[[https://keepachangelog.com/][https://img.shields.io/badge/Keep%20a%20Changelog--555.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9IiNmMTVkMzAiIHZpZXdCb3g9IjAgMCAxODcgMTg1Ij48cGF0aCBkPSJNNjIgN2MtMTUgMy0yOCAxMC0zNyAyMmExMjIgMTIyIDAgMDAtMTggOTEgNzQgNzQgMCAwMDE2IDM4YzYgOSAxNCAxNSAyNCAxOGE4OSA4OSAwIDAwMjQgNCA0NSA0NSAwIDAwNiAwbDMtMSAxMy0xYTE1OCAxNTggMCAwMDU1LTE3IDYzIDYzIDAgMDAzNS01MiAzNCAzNCAwIDAwLTEtNWMtMy0xOC05LTMzLTE5LTQ3LTEyLTE3LTI0LTI4LTM4LTM3QTg1IDg1IDAgMDA2MiA3em0zMCA4YzIwIDQgMzggMTQgNTMgMzEgMTcgMTggMjYgMzcgMjkgNTh2MTJjLTMgMTctMTMgMzAtMjggMzhhMTU1IDE1NSAwIDAxLTUzIDE2bC0xMyAyaC0xYTUxIDUxIDAgMDEtMTItMWwtMTctMmMtMTMtNC0yMy0xMi0yOS0yNy01LTEyLTgtMjQtOC0zOWExMzMgMTMzIDAgMDE4LTUwYzUtMTMgMTEtMjYgMjYtMzMgMTQtNyAyOS05IDQ1LTV6TTQwIDQ1YTk0IDk0IDAgMDAtMTcgNTQgNzUgNzUgMCAwMDYgMzJjOCAxOSAyMiAzMSA0MiAzMiAyMSAyIDQxLTIgNjAtMTRhNjAgNjAgMCAwMDIxLTE5IDUzIDUzIDAgMDA5LTI5YzAtMTYtOC0zMy0yMy01MWE0NyA0NyAwIDAwLTUtNWMtMjMtMjAtNDUtMjYtNjctMTgtMTIgNC0yMCA5LTI2IDE4em0xMDggNzZhNTAgNTAgMCAwMS0yMSAyMmMtMTcgOS0zMiAxMy00OCAxMy0xMSAwLTIxLTMtMzAtOS01LTMtOS05LTEzLTE2YTgxIDgxIDAgMDEtNi0zMiA5NCA5NCAwIDAxOC0zNSA5MCA5MCAwIDAxNi0xMmwxLTJjNS05IDEzLTEzIDIzLTE2IDE2LTUgMzItMyA1MCA5IDEzIDggMjMgMjAgMzAgMzYgNyAxNSA3IDI5IDAgNDJ6bS00My03M2MtMTctOC0zMy02LTQ2IDUtMTAgOC0xNiAyMC0xOSAzN2E1NCA1NCAwIDAwNSAzNGM3IDE1IDIwIDIzIDM3IDIyIDIyLTEgMzgtOSA0OC0yNGE0MSA0MSAwIDAwOC0yNCA0MyA0MyAwIDAwLTEtMTJjLTYtMTgtMTYtMzEtMzItMzh6bS0yMyA5MWgtMWMtNyAwLTE0LTItMjEtN2EyNyAyNyAwIDAxLTEwLTEzIDU3IDU3IDAgMDEtNC0yMCA2MyA2MyAwIDAxNi0yNWM1LTEyIDEyLTE5IDI0LTIxIDktMyAxOC0yIDI3IDIgMTQgNiAyMyAxOCAyNyAzM3MtMiAzMS0xNiA0MGMtMTEgOC0yMSAxMS0zMiAxMXptMS0zNHYxNGgtOFY2OGg4djI4bDEwLTEwaDExbC0xNCAxNSAxNyAxOEg5NnoiLz48L3N2Zz4K]] [[https://github.com/RichardLitt/standard-readme][https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square]] [[https://bestpractices.coreinfrastructure.org/projects/6084][https://bestpractices.coreinfrastructure.org/projects/6084/badge.svg]] [[https://codeberg.org/marcoXbresciani/TKCompanionApp/commits/branch/master][https://img.shields.io/maintenance/yes/2024.svg]] [[https://semver.org/][https://img.shields.io/badge/SemVer-2.0.0-informational.svg?logo=semver&style=plastic]] [[https://internal.repos.regiongold.com/bitbucket/projects/GDP/repos/customer-sdk/browse/.editorconfig][https://img.shields.io/static/v1.svg?label=use&logo=editorconfig&message=EditorConfig&style=plastic]] [[https://orgmode.org/][https://img.shields.io/badge/made%20with-OrgMode-blueviolet.svg?logo=gnuemacs]] [[https://hosted.weblate.org/engage/tkcompanionapp/][https://hosted.weblate.org/widgets/tkcompanionapp/-/svg-badge.svg]] [[https://blog.codinghorror.com/the-works-on-my-machine-certification-program/][file:https://img.shields.io/badge/works%20on-my%20machine-yellow.svg]] [[https://liberapay.com/marcoXbresciani/donate][https://liberapay.com/assets/widgets/donate.svg]] [[https://img.shields.io/liberapay/receives/marcoXbresciani.svg?logo=liberapay]] [[https://img.shields.io/liberapay/patrons/marcoXbresciani.svg?logo=liberapay]] [[https://fosstodon.org/@AAMfP][https://img.shields.io/mastodon/follow/000091124.svg?logo=mastodon]]

A short and small helper for Toyota Kata practitioners

Goal of this app is to be a practical vademecum/handbook for those interested in applying scientific thinking through Toyota Kata. It contains the Coaching Kata 5Q card, plus (possibly) more things and information. Content to be improved and updated from time to time.

+TOC: headlines 6

+BEGIN_QUOTE

DO NOT download TKCompanionApp from Google Play!!!

+END_QUOTE

Alert:

+BEGIN_QUOTE

Please note that TKCompanionApp is currently not on Google Play and won't be there in the near future.

There already was a case of an unwanted, ads-filled clone/copycat of TKCompanionApp on Google Play.

If you have downloaded TKCompanionApp from Google Play or Apple Play Store please, for your safety, remove it and install it only from F-Droid or from APK files available on the Codeberg repository.

+END_QUOTE

See file [[/docs/SECURITY.org][SECURITY.org]] for notes and updates related to security issues.

From [[http://www-personal.umich.edu/~mrother/Homepage.html][the Toyota Kata website]]:

+BEGIN_QUOTE

Toyota Kata is a way for managers and educators to initiate and coach practice of practical scientific-thinking skills in their teams, to develop and mobilize creative capability. Competitive conditions favor teams and organizations that know how to adapt. It's not as difficult as you might think, because you can begin by practicing a set of simple "Starter Kata."

Toyota Kata is about starter practice routines for developing scientific thinking. From there each individual & team can develop their own way.

Toyota Kata is a skill-building process that shifts you and your team from a natural tendency to jump to conclusions ... to thinking, working and reacting more scientifically. Best of all, you only need to practice 20 minutes a day, under the guidance of your coach.

+END_QUOTE

This app is currently built using React Native to make building the app for both Android and iOS from the same source code easier.

Unfortunately, publishing the app on Google Play Store or on Apple App Store, requires money I don't want to spend: it's [[https://support.google.com/googleplay/android-developer/answer/6112435?hl=en&ref_topic=3450769#zippy=%2Cstep-pay-registration-fee][one-time $25]] for a Google Developer Account, and it's even [[https://developer.apple.com/support/enrollment/][$99/year]] (!) for the Apple Developer Program.

+BEGIN_QUOTE

If you found it, DO NOT download TKCompanionApp from Google Play or Apple App Store: it's not the real one available from F-Droid or Codeberg!

+END_QUOTE

So (for now) you can find this app /only/ through the [[https://f-droid.org/][F-Droid]] /installable catalogue of FOSS (Free and Open Source Software) applications for the Android platform/.

[[https://f-droid.org/packages/name.bresciani.marco.tkcompanionapp][https://fdroid.gitlab.io/artwork/badge/get-it-on.png]]

To install this app, you then need the F-Droid client app (pretty similar to Google Play Store or Apple App Store) from the [[https://www.f-droid.org/][main site]]: there's an easy QR Code to download and [[https://en.wikipedia.org/wiki/F-Droid#Client_application][install it]].

Then, open the F-Droid repository app and search for [[https://f-droid.org/en/packages/name.bresciani.marco.tkcompanionapp/][TKCompanionApp]]. Install it, and open it.

Eventually, you can directly download the APK from the [[https://f-droid.org/en/packages/name.bresciani.marco.tkcompanionapp/][app page on F-Droid website]], to be installed manually on your device. There's no difference in functionalities, the only difference being the fact that without the F-Droid client app you won't receive automatic updates (just like Google Play did with other apps).

Welcome to the world of FOSS. Please also take a look at all other wonderful FOSS apps you can find in F-Droid.

Well, it's easy: install the app, open the app, click some buttons. There are no games, no quizzes, no actions to take (yet). Just sit, follow the menu, learn, practice and improve.

The app is divided into four main areas.

** Home :PROPERTIES: :CUSTOM_ID: home :END:

+ATTR_HTML: :width 300px

[[file:fastlane/metadata/android/en-US/images/phoneScreenshots/home.png]]

The Home page currently shows the 5Q card and also gives the possibility to:

+ATTR_HTML: :width 300px

[[file:fastlane/metadata/android/en-US/images/phoneScreenshots/about.png]]

** PDSA Journal :PROPERTIES: :CUSTOM_ID: pdsa-journal :END:

The PDSA Journal page allows you to daily write your answers to the 5Q card, with a reference calendar and navigation buttons.

+ATTR_HTML: :width 300px

[[file:fastlane/metadata/android/en-US/images/phoneScreenshots/pdsa.png]]

You are free to save and delete a full whole day or each single answer alone. You can also navigate directly to today (current, default day when opening the page) or browse the calendar.

** Documents :PROPERTIES: :CUSTOM_ID: documents :END:

The Documents page shows some reference documents and note from the Toyota Kata community.

+ATTR_HTML: :width 300px

[[file:fastlane/metadata/android/en-US/images/phoneScreenshots/docs.png]]

Together with the 5Q card there is the Kata Code and a few other things that you can read directly from the app or see their original source by opening the associated reference link.

+ATTR_HTML: :width 300px

[[file:fastlane/metadata/android/en-US/images/phoneScreenshots/5Q.png]]

+ATTR_HTML: :width 300px

[[file:fastlane/metadata/android/en-US/images/phoneScreenshots/tkc.png]]

** Events :PROPERTIES: :CUSTOM_ID: events :END:

This is a manually-updated list of known (by me!) events, world-wide, related to Toyota Kata.

Main source is currently [[https://twitter.com/RealMikeRother][Mike Rother's Twitter account]] but feel free to suggest more events.

+BEGIN_QUOTE

Note: since the app has no Internet connection, I have to manually update its content every time an event is expired or has to be added. It might be not realtime, but I prefer to preserve privacy instead of letting the app connect to the Internet, as far as I can.

+END_QUOTE

Events are listed in start dates order, with their official title as shown by the reference website, also added for navigation purposes (from your phone browser).

The app has been started by Marco Bresciani and is currently maintained by Marco Bresciani. Same for this document.

You can keep in touch with the author through:

** Translations :PROPERTIES: :CUSTOM_ID: translations :END:

Current (and past) contributors: [[https://hosted.weblate.org/engage/tkcompanionapp/][https://hosted.weblate.org/widgets/tkcompanionapp/-/287x66-grey.png]]

Thanks to (in appearing order):

See [[/docs/CONTRIBUTING.org][CONTRIBUTING.org]].

For contributing with translations in your own native language, you can see [[https://hosted.weblate.org/engage/tkcompanionapp/][Weblate]], that is the choosen platform for managing translations in multiple languages.

+BEGIN_QUOTE

You can even contribute through Liberapay:

+END_QUOTE

See =LICENSES= folder or =COPYING= files, for the whole licences text.

Overall project license, in brief: [[https://www.gnu.org/licenses/gpl-3.0.html][[[https://www.gnu.org/graphics/gplv3-or-later.svg]]]]

+BEGIN_SRC text

© 2021-2024 Marco Bresciani This file is part of TKCompanionApp.

TKCompanionApp is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

TKCompanionApp is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with TKCompanionApp. If not, see https://www.gnu.org/licenses/.

+END_SRC

This document license, in brief: [[https://img.shields.io/badge/license-CC_BY_SA-green?logo=creativecommons&labelColor=gray]]

+BEGIN_SRC text

© 2021-2024 Marco Bresciani

Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved. This file is offered as-is, without any warranty.

+END_SRC

+BEGIN_QUOTE

[[https://freedomdefined.org/upload/9/99/GPL_black.png]] This is a freely licensed work, as explained in the [[https://freedomdefined.org/Definition][Definition of Free Cultural Works]].

+END_QUOTE

[[https://www.gnu.org/software/freefont/index.html][Free Sans]] is the used font, and it's licensed [[https://www.gnu.org/software/freefont/license.html][under the terms of the GNU General Public License]].

Font used is [[https://www.gnu.org/software/freefont/index.html][Free Sans]].