FiloraFS-Lite quickstart

Prerequisites

The Maven wrapper is included, so system Maven is not required.

Java 21
Git
A current browser

Clone and run

Do not edit application.properties or create .env before the first run. The application starts on port 8080 with local development storage and a demo API key.

macOS / Linux

git clone https://github.com/buildbasekit/FiloraFS-Lite.git
cd FiloraFS-Lite
./mvnw spring-boot:run

Windows PowerShell

git clone https://github.com/buildbasekit/FiloraFS-Lite.git
Set-Location .\FiloraFS-Lite
.\mvnw.cmd spring-boot:run

Try the APIs

Open http://localhost:8080/api-test and use the displayed local API key.

Upload an allowed file.
List stored filenames.
Read file metadata.
Stream or download a stored file.
Delete the test file.

Verify the project

macOS / Linux

./mvnw clean verify

Windows PowerShell

.\mvnw.cmd clean verify

✓ FiloraFS-Lite is running and the local file flow has been verified.

Configure for development

Copy .env.example to .env only after the default flow works.

Set a persistent writable file directory.
Replace the demo API key.
Adjust file-size and content-type limits.
Keep local and production credentials outside version control.

FiloraFS-Lite configuration FiloraFS-Lite API reference