filemure/README.md

1.3 KiB

Filemure

Filemure is a simple document management application.

It supports:

  • uploading of files
  • tagging
  • search
  • download / export

Build

This project uses Gradle. To build and run the application, use the Gradle tool window by clicking the Gradle icon in the right-hand toolbar, or run it directly from the terminal:

  • Run ./gradlew run to build and run the application.
  • Run ./gradlew build to only build the application.
  • Run ./gradlew check to run all checks, including tests.
  • Run ./gradlew clean to clean all build outputs.

Note the usage of the Gradle Wrapper (./gradlew). This is the suggested way to use Gradle in production projects.

Learn more about the Gradle Wrapper.

Learn more about Gradle tasks.

This project follows the suggested multi-module setup and consists of the app and utils subprojects. The shared build logic was extracted to a convention plugin located in buildSrc.

This project uses a version catalog (see gradle/libs.versions.toml) to declare and version dependencies and both a build cache and a configuration cache (see gradle.properties).