files.md  by zakirullin

A local-first, private note-taking app for .md files

Created 3 years ago
2,822 stars

Top 16.4% on SourcePulse

GitHubView on GitHub
Project Summary

This project offers a private, local-first application for managing notes, documents, journals, and tasks using plain Markdown files. It targets users who prioritize data ownership, privacy, and simplicity, providing a quiet space for thinking and knowledge growth that is also LLM-friendly. The core benefit is fostering deep thinking and direct control over one's digital information without relying on external servers or complex ecosystems.

How It Works

The application operates as a Progressive Web App (PWA) running entirely in the browser, with a local-first architecture ensuring data never leaves the user's device by default. It emphasizes extreme simplicity, with a codebase designed to be understandable by a single person or an LLM. Users interact with plain .md files, allowing for offline use and direct compatibility with various tools. Optional synchronization is supported via cloud storage services (iCloud, Dropbox, Google Drive) or a self-hosted Go binary server.

Quick Start & Requirements

  • Primary install/run command: Access app.files.md in a web browser (Chrome recommended). Click "Install files.md" in the browser's address bar to enable PWA features. Open a local folder to persist changes.
  • Prerequisites: A modern web browser (Chrome recommended). For self-hosted sync, a Go environment is needed.
  • Links: Beta App: app.files.md, Main Site: files.md.

Highlighted Details

  • Local-First & Offline: All data is stored and processed locally, enabling full offline functionality.
  • Simple & Extensible: The codebase is intentionally minimal, designed for ease of understanding and extensibility, particularly for LLM integration.
  • Flexible Sync Options: Supports synchronization via existing cloud storage (iCloud, Dropbox, Google Drive) or a self-hosted Go server.
  • Telegram Chatbot: Provides on-the-go access and quick note-taking capabilities via a Telegram bot.
  • Philosophy: Encourages deep thinking by focusing on connecting ideas within plain Markdown files, eschewing complex features and plugins found in many "Second Brain" tools.

Maintenance & Community

The project has been under development for five years, with a strong emphasis on self-sufficiency and minimizing external dependencies. The codebase is designed to be understandable by junior developers, and the philosophy encourages simplifying rather than adding features. While specific community links (like Discord/Slack) are not provided, there is a call for GitHub support.

Licensing & Compatibility

The project is described as "free and open source." However, a specific license (e.g., MIT, GPL) is not explicitly stated in the provided text, which may require further clarification for commercial use or closed-source integration.

Limitations & Caveats

The primary application URL (app.files.md) is noted as being in Beta. The project's minimalist approach means it intentionally omits features found in more complex note-taking applications, focusing instead on core functionality to foster creativity through restriction. Users may occasionally need to perform a hard refresh to obtain updates.

Health Check
Last Commit

13 hours ago

Responsiveness

Inactive

Pull Requests (30d)
10
Issues (30d)
19
Star History
2,828 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.