Skip to content

Latest commit

 

History

History
97 lines (72 loc) · 4.4 KB

README.md

File metadata and controls

97 lines (72 loc) · 4.4 KB
Raw

Paintroid

Paintroid, also known as Pocket Paint, is associated to Catroid. It is a graphical paint editor application for the Android platform that, among others, allows setting parts of pictures to transparent.

Since Pocket Paint is now available in Google Play store you can also download Paintroid (Pocket Paint) from here. Alternatively, you can find it on **F-Droid ** here.

For more information oriented towards developers please visit our developers page.

Note This repository is the Flutter version of Paintroid

Getting Started

  1. Install Flutter:
    • Currently used version specified in .github/workflows/main.yml
    • Recommended: Use fvm for managing Flutter versions
  2. Get dependencies: make get
  3. Run app: make run

Alternatively make all can be used to:

flutter clean → flutter pub get → build_runner build → → flutter run

Building generated files

  • run make build

Tests

  • Run tests for all packages:
    • all: make test
    • unit: make unit
    • widget: make widget
    • integration: make integration

For integration tests:

Run the integration tests without device:

  1. Run make integration to run all integration tests
  2. Run make integration target=name_test to run a specific integration test file example: make integration target=line_tool
  3. Run make integration target=name_test id=n to run a specific test in a file example: make integration target=line_tool id=1 (make sure to add the test suffix to the test file name)

Run the integration tests with device:

  1. Make sure you have an iOS/Android device online by running flutter devices
  2. Run make integration-drive to run all integration tests
  3. Run make integration-drive target=name_test to run a specific integration test file example: make integration-drive target=line_tool
  4. Run make integration-drive target=name_test id=x to run a specific test in a file example: make integration-drive target=line_tool id=1 (make sure to add the test suffix to the file name)

Issues

Please report all bugs on our Jira Bugtracker

Contributing

If you want to contribute we suggest that you start with forking our repository and browse the code. Then you can look at our Issue-Tracker and start with fixing one ticket. Please make sure to pick a ticket with the status "Ready for development" and comment on the ticket that you are working on it. We strictly use Test-Driven Development and Clean Code, so first read everything you can about these development methods. Code developed in a different style will not be accepted. When you are done, comment again on the ticket and create a pull request on github. After you've created a pull request we will review your code and do a full testrun on your branch.

Let's start to set up the working environment using the instructions in our Wiki!

Resources and links

License

License of our project (mainly AGPL v3).