/piley

piley is a small To-Do app for Android that uses piles to manage your tasks.

Primary LanguageKotlinApache License 2.0Apache-2.0


Logo

piley

report bug · suggest feature · piley-server

Get it on Google Play
Table of Contents
  1. About piley
  2. Getting Started
  3. Contributing
  4. License

About piley

piley is a small To-Do app that uses piles to manage your tasks. You can stack up tasks within a pile, create and manage your piles and also set reminders and recurring tasks. If you set up a server, you can also back up your tasks and sync regularly to get the newest state.

(back to top)

Built With

piley is a native Android app built with Jetpack Compose. The following libraries were used:

  • Hilt for dependency injection
  • Room for data storage
  • OkHttp and Retrofit for remote calls
  • Material3 UI Elements and Compose navigation
  • Various Jetpack Compose, AndroidX and Accompanist dependencies for specific functionality

(back to top)

Getting Started

To start using piley, you can just get the newest apk from the Releases section, or download it from google play

Connect to piley-server

If you want to connect your app to a self-hosted piley-server backend to upload backups, you can input the url when signing in. You can also change the endpoint URL later in the user settings if your server location changes. The application allows cleartext traffic, meaning your endpoint can also be http.

The API url is by default 10.0.2.2 or 127.0.0.1 depending on the build type, which is used in emulators to connect to the localhost environment of the emulator host or the local computer api. You will need to change it unless you are running the app in an emulator. If your backup server is running on localhost for testing purposes, you can use http://10.0.2.2:8081 inside the emulator to avoid having to install a custom root certificate to use the https equivalent.

If you want to use an endpoint with a self-signed SSL certificate, you will have to manually add a network security config and include your certificate in trust-anchors. Then build the release apk as usual using Android Studio or the CLI. For more information about custom certificates, read the official documentation.

For information on getting started with piley-server, go here.

(back to top)

Planned features

To view planned features and track the general progress, visit the project board.

(back to top)

Contributing

piley is FOSS and was developed for free. You are welcome to contribute and support, here are a few ways:

(back to top)

License

Apache License 2.0

(back to top)