Blank Files Website

Laravel application that powers blankfiles.com. Browse and download minimal valid blank files by type and category. File data and assets are served from the filearchitect/blank-files repository via a configurable CDN.

Requirements

• PHP 8.2+
• Composer
• Node.js 18+ (for Vite frontend build)

Installation

git clone https://github.com/filearchitect/blankfiles-website.git
cd blankfiles-website
composer install
cp .env.example .env
php artisan key:generate

Set CDN_URL in .env (see Configuration). Then build the frontend and run the app:

npm install && npm run build
php artisan serve

Or use Laravel Herd with a .test domain.

Configuration

| Variable | Description | | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | CDN_URL | Required. Base URL used to construct downloadable file URLs as {CDN_URL}/files/{filename}. Default: https://raw.githubusercontent.com/filearchitect/blank-files/main (set in config/app.php). | | CATALOG_URL | Optional. Direct URL for the catalog JSON (files/files.json). Default is https://raw.githubusercontent.com/filearchitect/blank-files/main/files/files.json for freshness. | | CACHE_ENABLED | Optional. When true, the file list from the CDN is cached. TTL is controlled by CATALOG_TTL_MINUTES (default 10). See config/cache.php and app/Services/FileService.php. | | CATALOG_TTL_MINUTES | Optional. Cache TTL in minutes for the remote catalog when CACHE_ENABLED=true. Lower values reflect new formats sooner; higher values reduce CDN fetches. | | API_KEYS | Optional. Comma-separated API keys for higher-rate API clients (used by X-API-Key or Authorization: Bearer ...). | | API_PUBLIC_RATE_LIMIT | Optional. Public API requests/minute limit (default 30). | | API_KEY_RATE_LIMIT | Optional. API-key requests/minute limit (default 300). | | API_USAGE_LOG_CHANNEL | Optional. Logging channel for API usage analytics (default api_usage). | | OPENPANEL_CLIENT_ID | Optional. Enables OpenPanel web analytics script when set. | | OPENPANEL_CLIENT_SECRET | Optional. Reserved for server-side OpenPanel events (not exposed to browser script). |

Project structure

| Path | Purpose | | --------------------------------------------- | ------------------------------------------------------------ | | app/Http/Controllers/FileController.php | Web: homepage, file detail page, download proxy. | | app/Http/Controllers/Api/FileController.php | API: list all files, list files by type. | | app/Services/FileService.php | Fetches catalog JSON (CATALOG_URL) and formats file URLs from CDN_URL. | | routes/web.php

... View full README on GitHub