Awesome

Planka App

Planka App is an open-source mobile application developed using Flutter. It integrates with the Planka open-source project management platform via its API, allowing users to manage boards, lists, and tasks from their mobile devices.

Info

This project is being developed by someone who has a full-time job, so it won't move as quickly as you might hope. You are welcome to participate as a maintainer! I will try my best to fix all issues as fast as possible.

Release

All the APK´s of the versions can be found as attachments below each release. For IOS, please click here to join our testflight. We have a max. of 200 Users currently.

Features

Board Management: Create and manage project boards.
Task Lists: Organize tasks into lists for better workflow management.
Task Management: Add, update, delete, and organize tasks (cards) across lists.
Attachments: Upload and manage attachments for tasks.
User Authentication: Authenticate users through Planka's built-in authentication.
Multi-language Support: Support for multiple languages (coming soon).

Roadmap

App Wide Caching
Enhanced Multi Language Support
Renaming, Deleting, Creating of Projects
If you are pretty fluent in a language that does not exist already, feel free to translate!
Got any suggestions?

Installation

Prerequisites

Flutter SDK installed on your machine.
A running instance of the Planka API.

Steps to Install

1.Clone this repository:

   git clone https://github.com/LouisHDev/planka_app.git

2.Navigate to the project directory:

   cd planka_app

3.Install the dependencies:

   flutter pub get

4.Run the app on an emulator or a real device:

   flutter run

5.Tipp:

Don´t forget to add your local.properties for developing :)

Contributing

We welcome contributions to improve the Planka App! Whether you want to fix bugs, add new features, or improve documentation, your help is appreciated.

How to Contribute:

Fork the repository.
Create a new branch (git checkout -b feature-branch).
Commit your changes (git commit -m 'Add new feature').
Push the branch to your fork (git push origin feature-branch).
Open a pull request.

Before contributing, please ensure that all changes:

Follow the Flutter code style guidelines.
Pass all tests (flutter test).

Issues

If you find any bugs or want to suggest new features, feel free to open an issue.

Info

In the current App state, you will have to often refresh or go back to the boards and then back into where ever you were again. This is due to no caching at the moment. Planning to add this in the next Version. So keep in mind. The changes you´ve made are already on the Server, just not showing instantly.

Support

If you need any help or have questions regarding the project, you can reach out to the maintainer:

GitHub
Requests over Mail are not guaranteed to be answered.

License

This project is licensed under the The Commons Clause License. See the LICENSE file for details.

App Preview