This repository contains the web-version, Android-App and iOS-App of Cleanly. The backend-services are published under schmop/cleanly-server.
Cleanly is based on Users, coming together in a shared Household.
Recurring tasks may help your cleaning schedules, getting reminders to feed your pets, not forget to buy groceries in time or to do sportly activities.
You can receive push-notifications
- when tasks are due or
- when others finished a task (and appreciate one another!)
Gamify your tasks by giving them stars! Then after being competitive about the cleaning in your household for a while, you can compare your star-count ;)
Checklists help you collect, order and remind yourselves on collaborative lists. This can be a grocery list or a watch list for tv shows!
You need to install the Ionic CLI Framework. Then install the dependencies using:
yarn
When changing or adding types that have automatically-generated type-guards (using ts-auto-guard, use this to re-generate the type-guards:
npx ts-auto-guard
npm run translations
Create a dev-server using:
ionic serve
It will tell you your local ip aswell, please change getDevHostIp() in client/src/client/host.ts.
Add the google-services.json in android/app/google-services.json with the configuration of your Firebase-Account.
For more information, see https://firebase.google.com/docs/android/setup#add-config-file.
First build the assets for dev:
npm run build:dev
npm run sync:dev
Then open the android project using:
npx cap open android
To build the android app for production, please use:
npm run build
npm run sync
npx cap open android
Then build, test and bundle using Android Studio!
Can be found here: https://cleanly.schmoppo.de/changelog