TinyList 技术文档

TinyList 技术文档

tinylist Note-keeping/checklist application for use across devices, while respecting privacy. 项目地址: https://gitcode.com/gh_mirrors/ti/tinylist

TinyList 是一个安全、匿名且极简的渐进式Web应用程序（PWA），用于创建和管理待办事项列表。它专为追求隐私保护、简洁界面以及跨平台体验的用户设计。本文档旨在指导您如何安装、使用并深入了解TinyList项目。

安装指南

开发环境准备

1. 全局安装Quasar CLI：

   npm -g @quasar/cli
   

2. 项目依赖安装： 在项目根目录下执行：

   npm install
   

运行应用

• 要在开发模式下运行应用，以启用热重载等功能，请输入：

  quasar dev
  

  应用将在默认浏览器中自动打开。

• 对于生产环境构建，使用以下命令：

  quasar build -m pwa
  

  构建后的文件位于dist目录下，可以部署到任何静态服务器上。

Docker部署

详细步骤请参考项目中的Docker.md文件。此方法允许您快速启动整个应用程序环境，包含必要的服务。

项目使用说明

TinyList无需注册即可直接使用，支持现代设备，并能在离线状态下工作。通过浏览器访问即可开始创建您的第一份清单。对于高级功能如数据导出、标记等，请参照应用内的指引。

API使用文档

TinyList基于客户端JavaScript与后端数据库交互，主要利用了PouchDB作为本地存储，同步至CouchDB云端数据库。虽然该应用并未公开外部API接口，但开发者可以通过阅读源码来了解组件间通信和数据处理逻辑，特别是src/store和与数据库交互的部分。

项目安装方式

对于终端用户，访问TinyList的在线地址直接使用即可。对于想要自托管或者贡献代码的开发者：

1. 克隆项目：

   git clone https://github.com/baggachipz/tinylist.git
   

2. 遵循以上安装与运行步骤进行本地搭建。

技术栈简介

• Quasar Framework: 提供高效的开发框架。
• Vue.js: 驱动UI的响应式框架。
• Vue-Draggable: 支持拖拽排序的Vue插件。
• PouchDB/CouchDB: 实现数据的持久化存储和云同步。
• markdown-it: Markdown解析器，用于笔记编辑。
• file-saver & JSZip: 文件保存与压缩库，方便数据导入导出。
• qrcode-svg: 生成二维码的功能库。

如果您对项目有额外的支持意愿，请考虑通过提供的链接资助该项目，以助其持续发展和维护。希望这份文档能让您更好地理解和使用TinyList应用。

tinylist Note-keeping/checklist application for use across devices, while respecting privacy. 项目地址: https://gitcode.com/gh_mirrors/ti/tinylist