Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/peponi/fxos-app-todo-couchdb-sync

todo app who provide CouchDB synchronization, dependencies and prioritization
https://github.com/peponi/fxos-app-todo-couchdb-sync

Last synced: 12 days ago
JSON representation

todo app who provide CouchDB synchronization, dependencies and prioritization

Awesome Lists containing this project

README 

        
[![No Maintenance Intended](http://unmaintained.tech/badge.svg)](http://unmaintained.tech/)



![screenshot](_assets/just-do-it.jpg)



# My Custom Todo WebApp (ﾉ◕ヮ◕)ﾉ*:･ﾟ✧



> It's a WebApp optimzed for [Firefox OS 1.0 up to 2.6](https://www.mozilla.org/de/firefox/os/), but will works on Android and iOS legacy phones too



Goal is to build a todo webapp who provide 



* Server (CouchDB) synchronization ✓

* Backup export, import ✓

* Todo dependencies 

* Prioritization ✓

* Offline support

* Crossbrowser support (FirefoxOS, Android, iOS, Ubuntu Touch)



## Build with 



 * [Mozilla buildingfirefoxos.com](http://buildingfirefoxos.com), ([github](https://github.com/buildingfirefoxos/Building-Blocks))

 * [KnockoutJS](http://knockoutjs.com)

 * [PouchDB](https://pouchdb.com)

 * [fecha](https://github.com/taylorhakes/fecha)

 * [google-webfonts-helper](https://google-webfonts-helper.herokuapp.com/fonts) <- thx for this tool

 * [Launcher Icon Maker](https://appmaker.merq.org/tools) & [iconogen.com](http://iconogen.com)



## Screenshots



![screenshot](_assets/screenshot1.png)

![screenshot](_assets/screenshot2.png)

![screenshot](_assets/screenshot.png)

## User story



As a **FirefoxOS user** I want to have a todo app who will rember me on important stuff

so that I can outsource my brain capacity to the phone, yeai



### Acceptance criteria



- [x] groups can be saved and deleted

- [x] todos can be saved, toggeled and deleted

- [x] todos will be shown in a list

- [x] todos will be shown filtered by group

- [x] todos will be ordered by priority

- [x] and by date

- [x] priority will be signaled by color

- [x] start screen, when first start

- [x] settings will be loaded on startup (language/couchdb)

- [x] synchronization to a CouchDB works

- [ ] install banner on FirefoxOS ✓ & iOS ✓ & Android

- [ ] works offline (✓ appcache für iOS)

- [x] todos can be edit

- [x] links in the todo description will be shown as html link in the edit mode

- [ ] it will show a message if a todo has been toggle with an unsolved dependency (other todo is not done)

- [x] group delete will show a confirm message and delete all dependet todos 

- [x] app will run on FXOS 1.0

- [ ] app will run on Android and can be pinned to desktop

- [ ] app will run on [iOS](http://stackoverflow.com/questions/17306806/how-can-you-give-your-mobile-web-app-an-install-screen) [[1](https://developer.apple.com/library/ios/documentation/AppleApplications/Reference/SafariWebContent/ConfiguringWebApplications/ConfiguringWebApplications.html)] [[2](http://brolik.com/blog/installable-web-apps-open-web/)]



### Feature whishlist



- [ ] app will run on Ubuntu Touch and can be [pinned to desktop](https://cordova.apache.org/docs/de/latest/guide/platforms/ubuntu/) [[1](http://developer.ubuntu.com/en/phone/web/)]

- [x] DB export to JSON file

- [x] read JSON file and import to DB

- [ ] export to [CVS](https://marketplace.firefox.com/app/planr/) [1](https://github.com/corbindavenport/planr)

- [ ] read CVS file and import to DB

- [x] phone will [vibrate](https://www.sitepoint.com/use-html5-vibration-api) while notify is poping up

- [ ] Android [web](https://developer.chrome.com/multidevice/android/intents) [intents](http://webintents.org/#support) has been tested

- [ ] themes (ios, android, cyberUI)

- [ ] [crypto-pouch](https://github.com/calvinmetcalf/crypto-pouch) ausprobieren

- [ ] [Knockout Components](http://knockoutjs.com/documentation/component-overview.html) ausprobieren für app install banner

- [ ] transaltion can be added

- [ ] it will prefer the system default language

- [ ] open input form whit phone [shaking](https://github.com/alexgibson/shake.js) [1](http://qnimate.com/detect-shake-using-javascript)

- [ ] LTR/RTL works

- [ ] sharing lists with [other user](https://github.com/nolanlawson/pouchdb-authentication) via couchdb accounts

- [ ] show all groups with all todos in a [pie chart](http://www.chartjs.org/docs/#doughnut-pie-chart-introduction) like landingpage by [small and big dots](https://media-mediatemple.netdna-ssl.com/wp-content/uploads/2016/03/02-beats-opt.jpg)

- [ ] archivements for completing todos



### Feature Table



| - | [FirefoxOS](https://en.wikipedia.org/wiki/Firefox_OS) ||||| Android [Cyanogen Mod](https://en.wikipedia.org/wiki/CyanogenMod)  ||| iOS  || [Ubuntu Touch](http://www.ubuntu.com/phone) | [SailfishOS](https://sailfishos.org) | Chrome | Firefox |

| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |

| **Version** |**1.0**|**1.1**|**2.0**|**2.2**|**2.6**|**4.3**|**4.4**|**5**|**5**|**6**|**BQ E4.5**|**2**|**51**|**47**|

| **Onbording Startscreen** | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |

| **DB Backup Export** | ❌ | ❌ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ❌ | ❌ | A? | ✓ | ✓ | ✓ |

| **DB Backup Import** | ❌ | ❌ | ✓ | ? | ✓ | ✓ | ✓ | ✓ | ❌ | ❌ | ✓ | A? | T? | ✓ |

| **DB Synchronisation** | ✓ | N? | ✓ | N? | ✓ | ✓ | N? | N? | N? | N? | N? | N? | ✓ | ✓ |

| **App Installation** | ✓ | ✓ | ✓ | ✓ | ✓ | N? | N? | N? | N? | N? | F❌ | ❌ | F❌ | F❌ |

| **Works Offline** | ✓ | ✓ | ✓ | ✓ | ✓ | N? | N? | N? | N? | N? | N? | N? | N? | N? |

| **Calendar Activity/Intent** | N | N | N | N | N | N | N | N | N | N | N | N | N | N |

| **Desktop Screen** | - | - | - | - | - | - | - | - | - | - | - | - | N | N |



|sign| meaning|

| --- | --- |

| ✓ | works |

| ❌ | don't works because of technical reason |

| F❌ | wold be possible by other technical features |

| A? | don't works because some app or app feature is missing, the right app could help |

| T? | should work, but don't, need to test this |

| N? | not tested yet |

| N | not implemented yet |

| - |feature not neccessary for this device / os / screenport|



### Bugs



- [ ] **heisenbug** - viewModel.js:75 Uncaught TypeError: Cannot set property 'className' of null

- [ ] won't reload after json import db overwrite

- [ ] db synchronization got a cookie error after type in of credentials

- [ ] db synchronization dosn't refresh the todo list after first app start, second start works then (timing problem ?)

- [ ] sm.transaction in vm.onnectToCouchDb will be called while vm.init(), find better solution

- [ ] app install banner won't automatic fade out after installation

- [ ] can't turn off sync & save



### Code Refactoring



see [TODO.md](./TODO.md) file



## CouchDB



if you want to sychronize your data, you need to install and configure a [CouchDB](https://couchdb.apache.org)

* [how to install couchdb and futon on ubuntu 14 04](https://www.digitalocean.com/community/tutorials/how-to-install-couchdb-and-futon-on-ubuntu-14-04)

* [how to install couchdb on a RaspberryPI - Raspbian Jessie](http://jeeonthepi.blogspot.ch/2014/08/installing-couchdb-1.html)



when you done this and login to Futon, create following databases



* *couchdb-databbase-prefix-***group**

* *couchdb-databbase-prefix-***todo**



then configure your app in 



> menu -> Database -> Sync to CouchDB



choose somthing clear as prefix like **my-fxos-todo-app-** or leave this blank if you don't wan't to use your CouchDB for something else



# Development



## Install

```

npm install

gulp build

```

and run a webserver

```

npm run http

```

then click on [http://127.0.0.1:8000](http://127.0.0.1:8000)



to develop on the service worker offline stuff



```

npm run chrome

npm run https

gulp build --no-appcache

```

then click on [https://127.0.0.1:8000](https://127.0.0.1:8000)



## CouchDB setup 



if you want to work on the synchronization and need to debug in your Chrome browser,

you need to enable [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) in your [CouchDB](https://couchdb.apache.org)



[github.com/pouchdb/add-cors-to-couchdb](https://github.com/pouchdb/add-cors-to-couchdb#what-it-does)



*CouchDB doesn't come with CORS enabled by default. This is a problem for libraries like PouchDB, which depend on being able to access CouchDB ...*