agentleFS
Sign inStart free
RoastSlavRoastSlav/quickdrop/.github/copilot-instructions.md

quickdrop

Copilot instructions433 starsChanged 10 months agoMITView on GitHub

Self-hosted file sharing: Spring Boot 3.5 + Thymeleaf + SQLite (Flyway) + Tailwind. Java 21. - Build: ./mvnw clean package (Windows: mvnw.cmd clean package). Output: target/quickdrop.jar. - Run: java -jar target/quickdrop.jar → http://localhost:8080. - Tailwind CSS: npm run tw:build rebuilds src/main/resources/static/css/tailwind.css from tailwind-input.css. - No test suite — verify via manual package + smoke test. Logs at log/quickdrop.log, DB at db/quickdrop.db, uploads under files/ (all auto-created by QuickdropApplication). - Docker: roastslav/quickdrop:latest, exposes 8080; mount /app/db, /app/files, /app/log. - Controllers (controller/):…

We split this copilot-instructions.md into the rules it gives an agent

3 rules. About 0 are common, 0 are distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Run: java -jar target/quickdrop.jar → http://localhost:8080.

    line 8
  2. Very specific:

    No test suite — verify via manual package + smoke test.

    line 10
  3. Very specific:

    Add new protected routes via the right interceptor: AdminPasswordSetupInterceptor (forces /admin/setup until admin pwd exists), …

    line 51

≈ “Common” is an estimate: at least 1 in 5 of the 3,669 Copilot instructions files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
copilot-instructions.md

QuickDrop — Agent Guide

Self-hosted file sharing: Spring Boot 3.5 + Thymeleaf + SQLite (Flyway) + Tailwind. Java 21.

Build & run

  • Build: ./mvnw clean package (Windows: mvnw.cmd clean package). Output: target/quickdrop.jar.
  • Run: java -jar target/quickdrop.jar → http://localhost:8080.
  • Tailwind CSS: npm run tw:build rebuilds src/main/resources/static/css/tailwind.css from tailwind-input.css.
  • No test suite — verify via manual package + smoke test. Logs at log/quickdrop.log, DB at db/quickdrop.db, uploads under files/ (all auto-created by QuickdropApplication).
  • Docker: roastslav/quickdrop:latest, exposes 8080; mount /app/db, /app/files, /app/log.

Architecture (follow the layers)

  • Controllers (controller/): FileViewController, AdminViewController, FileRestController (chunked upload + share APIs), ShareViewController, PasswordViewController, IndexViewController. Thymeleaf views in src/main/resources/templates/.
  • Services (service/) own all business logic. Route every file mutation through FileService so history logging, cache eviction, encryption and notifications fire.
  • Upload pipeline: POST /api/file/upload-chunk → AsyncFileMergeService buffers chunks → FileEncryptionService encrypts when password + encryption flag set → FileService persists. Intermediate chunk calls return null; frontend must handle. Metadata fields: description, keepIndefinitely, password, hidden, fileSize, folder fields, isPaste.
  • Download: /file/download/{uuid} streams with on-the-fly decryption and logs DOWNLOAD into file_history_log ( types: UPLOAD, RENEWAL, DOWNLOAD). Share links via /api/file/share/{uuid} issue tokens redeemed at /api/file/download/{uuid}/{token} (decrement/delete).
  • Storage/model: UUID filenames on disk at fileStoragePath (from settings); file_entity row holds metadata + optional BCrypt password hash + encrypted flag + folder + isPaste.

Settings (single-row, id=1)

  • ApplicationSettingsService seeds defaults on startup (max 1 GB, 30-day life, files/logs paths, cron 0 0 2 * * *, encryption on, default home = upload, SMTP/Discord off, etc.) and re-schedules cleanup when cron changes. Never insert a second settings row.
  • Template-level feature flags (file list enabled, app password set, admin button, encryption on, previews, pastebin) are injected by GlobalControllerAdvice — read from there; don't duplicate.

Security & interceptors

  • SecurityConfig: optional whole-app password at /password/login, BCrypt, CSRF cookie, permissive CORS. Session timeout configured in WebConfig.
  • In-memory admin + file session tokens live in SessionService (not persisted — restarts invalidate).
  • Add new protected routes via the right interceptor: AdminPasswordSetupInterceptor (forces /admin/setup until admin pwd exists), AdminPasswordInterceptor (/admin/** + file history), FilePasswordInterceptor (redirects to /file/password/{uuid} when the file has a password and no valid session token).

Migrations & persistence

  • Flyway migrations in src/main/resources/db/migration/V*__*.sql (currently V1–V20). Baseline-on-migrate is enabled — append a new V{n+1}__...sql, never edit existing files. SQLite dialect is org.hibernate.community.dialect.SQLiteDialect.
  • Entities in entity/, Spring Data repos in repository/. Use @Transactional on service methods that mutate.

Pagination, search & cache

  • Public list (/files) and admin dashboard use page/size/query params backed by Page<FileEntity> service methods — reuse them and pass all three params through to templates.
  • Spring Cache keys are publicFiles, adminFiles, analytics (see CacheConfig). Any upload, deletion, renewal, visibility/keep toggle, or download must evict these — copy the @CacheEvict pattern from FileService.

Scheduling & notifications

  • @EnableScheduling + ScheduleService handles expiry deletion (cron from settings), missing-file row cleanup, share token expiry. Reschedule by calling its rescheduleCleanup(...) when cron changes.
  • NotificationService batches email + Discord webhook events per configured interval; call it from FileService, not controllers.

i18n

  • Bundles: messages.properties, messages_bg.properties, messages_de.properties. Add every new user-facing string to all three (see docs/i18n.md). Resolver wired in I18nConfig.

Download now (ZIP)

  • Where files are headingNew Copilot instructions files have more rules about branches and pull requests, and fewer about code style.

    Of the Copilot instructions files we read, the 2,297 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repositoryOne other file it gives its agents.

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free