FiloraFS-Lite quickstart

Prerequisites

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

• Java 25
• Git
• A current browser

Clone and run

No application.properties edits or .env file are required. The application starts on port 8080, creates ./uploads relative to the working directory, and uses filorafs-local-dev-key for local evaluation. No database or cloud service is required.

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

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. The API-key field is prefilled with filorafs-local-dev-key; enter your own value if you override the server key.

• Upload a PNG, JPEG, PDF, or WebP file below the default 10 MB file and request limits; allow room for multipart overhead.
• List stored filenames.
• Read file metadata.
• Download a stored file as an attachment.
• Delete the test file.

Verify the project

./mvnw clean verify

.\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 when you need overrides, uncomment the required values, and restart.

• Set FILORAFS_STORAGE_PATH to a persistent writable directory.
• Replace the development key with FILORAFS_API_KEY before deployment.
• Adjust FILORAFS_MAX_FILE_SIZE and FILORAFS_MAX_REQUEST_SIZE when needed; allowed types are defined in FileService, not .env.
• Keep local and production credentials outside version control.