-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
#1 add more detail to README.md dwyl/home#256
- Loading branch information
Showing
1 changed file
with
122 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,83 +6,172 @@ | |
|
||
</div> | ||
|
||
# Why? | ||
# Why? π€·ββοΈ | ||
|
||
Our house is untidy. | ||
There is clutter | ||
(`objects` that don't belong in a particular room/surface) | ||
(`objects` that don't belong | ||
in a particular room/surface) | ||
_everywhere_. | ||
It's _exhausting_. | ||
And it's deeply negative. | ||
It's both mentally and physically _exhausting_ | ||
and deeply negative | ||
to both adults | ||
and _especially_ children. π’ | ||
|
||
We need to resolve this as our _highest_ priority | ||
because it affects us every day. | ||
|
||
## _Many_ People Have this Problem | ||
## _Many_ People Have Are Affected? π | ||
|
||
If you come from a home | ||
where everything has a place | ||
and is always perfectly tidy, | ||
count yourself _exceptionally_ lucky! | ||
This is _not_ the "norm". | ||
|
||
Many `people` have this problem ... | ||
|
||
![cluttered-house](https://github.com/dwyl/home/assets/194400/8b598f6d-da01-4607-a83f-28b3bddb0f78) | ||
Image credit: | ||
[clutterfreenow.com/blog/decluttering/cluttered-house-the-worst](https://clutterfreenow.com/blog/decluttering/question-is-my-cluttered-house-the-worst-youve-seen/) | ||
[clutterfreenow.com/blog/decluttering/cluttered-house-the-worst](https://clutterfreenow.com/blog/decluttering/question-is-my-cluttered-house-the-worst-youve-seen/) <br /> | ||
Plenty more examples: | ||
[google.com/search?q=clutter&tbm=isch](https://www.google.com/search?q=clutter&tbm=isch) | ||
[google.com/search?q=clutter&tbm=isch](https://www.google.com/search?q=clutter&tbm=isch) <br /> | ||
Just looking at these images triggers anxiety for me ... π¬ <br /> | ||
If you feel the same way, read on! | ||
|
||
[Marie Kondo](https://en.wikipedia.org/wiki/Marie_Kondo) | ||
wouldn't _need_ | ||
to write | ||
"_The **Life Changing Magic** of **Tidying Up**_" - | ||
the NYT Bestseller that has **sold** more than | ||
[**9 Million Copies**](https://github.com/dwyl/home/issues/256#issuecomment-1742853750) - | ||
if this wasn't a _widespread_ issue. | ||
|
||
## Hoarders? π | ||
|
||
At the extreme, | ||
accumulation of `objects` cluttering | ||
people's homes is called | ||
[hoarding disorder](https://en.wikipedia.org/wiki/Hoarding_disorder). | ||
It is estimated that around **2% β 6%** of the population | ||
suffers from it: | ||
[iocdf.org/about-hoarding/who-gets-hoarding-disorder](https://hoarding.iocdf.org/about-hoarding/who-gets-hoarding-disorder/) | ||
If these estimates are correct it's tens of millions of `people`. | ||
|
||
# What? | ||
If we can build a _simple_ App | ||
that can help both the hoarders | ||
and their long-suffering family, | ||
we can **_significantly_ improve millions of lives**. | ||
|
||
A micro app with a _single_ goal: | ||
help you declutter, tidy & organize your physical environment | ||
thus unlocking your "best life". | ||
# What? β¨ | ||
|
||
A micro app with a **_simple_ goal**: | ||
help you **declutter, tidy & organize** | ||
your **_physical_ environment** | ||
so you can start living your "***best life***". | ||
|
||
# When? | ||
|
||
# When? β³ | ||
|
||
We want to build this mini app | ||
so we can _use_ it internally `ASAP`. | ||
|
||
# Who? π₯ | ||
|
||
# Who? | ||
|
||
For now, `tiny` is exclusively for use | ||
For now, `tiny` is used | ||
by the `people` living/working | ||
[`@home`](https://github.com/dwyl/home/issues/256). | ||
|
||
But if we can refine the features/functionality, | ||
we will encourage others to use it. | ||
|
||
## Market? | ||
|
||
If you come from a home where everything has a place | ||
and is always perfectly tidy, | ||
count yourself _exceptionally_ lucky! | ||
This is _not_ the "norm". | ||
If it was, | ||
# How? π» | ||
|
||
[Marie Kondo](https://en.wikipedia.org/wiki/Marie_Kondo) | ||
wouldn't have _needed_ | ||
to write an NYT Bestseller | ||
"_The Life Changing Magic of Tidying Up_" | ||
which has sold more than | ||
[**9 Million Copies**](https://github.com/dwyl/home/issues/256#issuecomment-1742853750). | ||
Try it: | ||
|
||
# How? | ||
|
||
Try it: | ||
|
||
## Run it β¬οΈ | ||
|
||
1. Clone the repo: | ||
|
||
```sh | ||
git clone [email protected]:dwyl/tidy.git && cd tidy | ||
``` | ||
|
||
2. Install the dependencies and create the database: | ||
|
||
```sh | ||
source .env_sample | ||
mix setup | ||
``` | ||
|
||
3. Run the app: | ||
|
||
```sh | ||
mix s | ||
``` | ||
|
||
#Β TODO: add screenshot! | ||
|
||
|
||
## Build It! π·ββοΈ | ||
|
||
The creation of this mini-app is _fully_ documented in: | ||
[dwyl/book/tidy/](https://dwyl.github.io/book/tidy/) | ||
|
||
|
||
## Feedback! π | ||
|
||
Your feedback is very much encouraged/welcome! π¬<br /> | ||
If you find the repo interesting/useful, please β on GitHub. <br /> | ||
And if you have any questions, | ||
please open an issue: | ||
[app-mvp/issues](https://github.com/dwyl/app-mvp/issues) β | ||
<br /> | ||
|
||
|
||
## Contributing π©βπ» | ||
|
||
All contributions | ||
from typo fixes | ||
to feature requests | ||
are always welcome! π | ||
|
||
## Run it | ||
Please start by: <br /> | ||
a. **Star** the repo on GitHub | ||
so you have a "bookmark" you can return to. β <br /> | ||
b. **Fork** the repo | ||
so you have a copy you can "hack" on. π΄ <br /> | ||
c. **Clone** the repo to your `localhost` | ||
and run it! (see below) π©βπ» <br /> | ||
|
||
|
||
For more detail, | ||
please see: | ||
[dwyl/**contributing**](https://github.com/dwyl/contributing) | ||
|
||
## Build It! | ||
### More Features? π | ||
|
||
Please note that our goal with this MVP | ||
is _not_ to have _all_ the features; | ||
again, it's _deliberately_ simple.<br /> | ||
We will be adding _lots_ more features | ||
to the _full_ | ||
[**App**](https://github.com/dwyl/app). <br /> | ||
If you have feature ideas, that's great! π <br /> | ||
Please _share_ them: | ||
[**app/issues**](https://github.com/dwyl/app/issues) | ||
|
||
|
||
|
||
|
||
<sup>1</sup>**`Tidy`** is our | ||
[**Working title**](https://en.wikipedia.org/wiki/Working_title) | ||
for this mini App | ||
so we can discuss it internally. | ||
so we can discuss it internally. π‘π©βπ»<br /> | ||
If you have a name idea/suggestion | ||
that better describes | ||
what we are building, | ||
please share! π | ||
please share! ππ¬ |