feat: update readme

2025-01-26 10:57:46 +08:00
parent 09533df30a
commit 2e21a14b50
2 changed files with 532 additions and 107 deletions
@@ -1,63 +1,290 @@
+# FileCodeBox
+
 <div align="center">
-<h1>File Delivery Cabinet - Lite</h1>
-<h2>FileCodeBox-Lite</h2>
-<p><em>Anonymous passcode sharing of text and files, picking up files just like picking up express deliveries</em></p>
-<p>Join our QQ Group: 739673698</p>
+
+<img src="https://fastly.jsdelivr.net/gh/vastsa/FileCodeBox@V1.6/static/banners/img_1.png" alt="FileCodeBox Logo">
+
+<p><em>Share text and files anonymously with a passcode, like picking up a package</em></p>
+
+[![GitHub stars](https://img.shields.io/github/stars/vastsa/FileCodeBox)](https://github.com/vastsa/FileCodeBox/stargazers)
+[![GitHub forks](https://img.shields.io/github/forks/vastsa/FileCodeBox)](https://github.com/vastsa/FileCodeBox/network)
+[![GitHub issues](https://img.shields.io/github/issues/vastsa/FileCodeBox)](https://github.com/vastsa/FileCodeBox/issues)
+[![GitHub license](https://img.shields.io/github/license/vastsa/FileCodeBox)](https://github.com/vastsa/FileCodeBox/blob/master/LICENSE)
+[![QQ Group](https://img.shields.io/badge/QQ%20Group-739673698-blue.svg)](https://qm.qq.com/cgi-bin/qm/qr?k=eMXxqKZBrwjWYgPgpBjhQ8-q8_eK-BoR&jump_from=webapi&authKey=6vXVaJ3nXgEVoQzV9OFX+XvRyPJhJd7l9QQhBkZz+qBk1YYqxUXyqBuPL4WLkjMj)
+[![Python Version](https://img.shields.io/badge/Python-3.8+-blue.svg)](https://www.python.org)
+[![FastAPI](https://img.shields.io/badge/FastAPI-0.68+-green.svg)](https://fastapi.tiangolo.com)
+[![Vue Version](https://img.shields.io/badge/Vue.js-3.x-brightgreen.svg)](https://v3.vuejs.org)
+
+[简体中文](./readme.md) | [Deployment Guide](https://github.com/vastsa/FileCodeBox/wiki/Deployment-Guide) | [FAQ](https://github.com/vastsa/FileCodeBox/wiki/FAQ)
+
 </div>

-![banner](https://fastly.jsdelivr.net/gh/vastsa/FileCodeBox@V1.6/static/banners/img_1.png)
+## 📝 Introduction

---
+FileCodeBox is a lightweight file sharing tool developed with FastAPI + Vue3. It allows users to share text and files easily, where recipients only need a passcode to retrieve the files, just like picking up a package from a delivery locker.

-<div align="center" style="text-align: center;margin: 20px 0">
-    <a href="./readme.md">简体中文</a> | 
-    <a href="./readme_en.md">English</a> | 
-    <a href="https://github.com/vastsa/FileCodeBox/wiki/Deployment-Tutorial">Deployment Guide</a> | 
-    <a href="https://github.com/vastsa/FileCodeBox/wiki/Frequently-asked-questions">FAQ</a>
+## 🖼️ Preview
+
+<div align="center">
+<h3>
+<a href="https://github.com/vastsa/FileCodeBoxFronted" target="_blank">
+<img src="https://img.shields.io/badge/Frontend-FileCodeBoxFronted-blue?style=for-the-badge&logo=github" alt="Frontend Repository">
+</a>
+&nbsp;&nbsp;&nbsp;
+<a href="https://share.lanol.cn" target="_blank">
+<img src="https://img.shields.io/badge/Demo-share.lanol.cn-green?style=for-the-badge&logo=internet-explorer" alt="Demo Site">
+</a>
+</h3>
 </div>

-## Screenshots
+### New Interface
+<div align="center">
+<table>
+<tr>
+<td><img src="./.github/images/img_7.png" alt="File Upload" title="File Upload Interface"></td>
+<td><img src="./.github/images/img_8.png" alt="Text Share" title="Text Share Interface"></td>
+</tr>
+<tr>
+<td><img src="./.github/images/img_10.png" alt="File Management" title="File Management Interface"></td>
+<td><img src="./.github/images/img_9.png" alt="System Settings" title="System Settings Interface"></td>
+</tr>
+<tr>
+<td><img src="./.github/images/img_11.png" alt="Mobile View" title="Mobile Interface"></td>
+<td><img src="./.github/images/img_12.png" alt="Dark Mode" title="Dark Mode Interface"></td>
+</tr>
+<tr>
+<td><img src="./.github/images/img_13.png" alt="Internationalization" title="Language Support"></td>
+<td><img src="./.github/images/img_14.png" alt="Responsive" title="Responsive Design"></td>
+</tr>
+</table>
+</div>

-<table style="width:100%">
-<tr style="width: 100%">
-<td style="width: 50%"><img src="./.github/images/img.png" alt="Send Files"></td>
-<td style="width: 50%"><img src="./.github/images/img_1.png" alt="Send Files"></td>
+### Classic Interface
+<div align="center">
+<table>
+<tr>
+<td><img src="./.github/images/img.png" alt="Home" title="Home Page"></td>
+<td><img src="./.github/images/img_1.png" alt="Upload" title="Upload Interface"></td>
 </tr>
-<tr style="width: 100%">
-<td style="width: 50%"><img src="./.github/images/img_2.png" alt="Send Files"></td>
-<td style="width: 50%"><img src="./.github/images/img_3.png" alt="Send Files"></td>
+<tr>
+<td><img src="./.github/images/img_2.png" alt="Management" title="Management Interface"></td>
+<td><img src="./.github/images/img_3.png" alt="Settings" title="Settings Interface"></td>
 </tr>
-<tr style="width: 100%">
-<td style="width: 50%"><img src="./.github/images/img_4.png" alt="Send Files"></td>
-<td style="width: 50%"><img src="./.github/images/img_5.png" alt="Send Files"></td>
+<tr>
+<td><img src="./.github/images/img_4.png" alt="Share" title="Share Interface"></td>
+<td><img src="./.github/images/img_5.png" alt="Download" title="Download Interface"></td>
+</tr>
+</table>
+</div>
+
+## 🎯 Use Cases
+
+<table>
+<tr>
+<td align="center">
+<h4>📁 Temporary File Sharing</h4>
+Quick file sharing without registration
+</td>
+<td align="center">
+<h4>📝 Quick Text Sharing</h4>
+Share code snippets and text content
+</td>
+<td align="center">
+<h4>🕶️ Anonymous Transfer</h4>
+Privacy-protected file transfer
+</td>
+</tr>
+<tr>
+<td align="center">
+<h4>💾 Temporary Storage</h4>
+File storage with expiration time
+</td>
+<td align="center">
+<h4>🔄 Cross-platform Transfer</h4>
+Quick file transfer between devices
+</td>
+<td align="center">
+<h4>🌐 Private Share Service</h4>
+Build your own file sharing service
+</td>
 </tr>
 </table>

-## Key Features
+## ✨ Core Features

- [x] **Lightweight and Simple:** Built on Fastapi + Sqlite3 + Vue3 + ElementUI
- [x] **Easy Upload:** Supports copy-paste and drag-and-drop selection
- [x] **Multiple Types:** Supports text and files
- [x] **Brute-Force Protection:** Limits on wrong attempts
- [x] **Abuse Prevention:** IP-based upload limits
- [x] **Passcode Sharing:** Random passcodes for storing and retrieving files, customizable retries, and expiration periods
- [x] **Internationalization:** Supports Simplified Chinese, Traditional Chinese, English, etc.
- [x] **Anonymous Sharing:** No registration or login required
- [x] **Admin Panel:** View and delete files
- [x] **One-Click Deployment:** Supports Docker one-click deployment
- [x] **Flexible Expansion:** Supports S3 protocol and local file streams, with the ability to add new storage engines in the storage file
- [x] **Simple and Clear:** Ideal for beginner projects
- [x] **Terminal Download:** Terminal command `wget https://share.lanol.cn/share/select?code=83432`
+<table>
+<tr>
+<td align="center">
+<h4>🚀 Lightweight</h4>
+Based on FastAPI + SQLite3 + Vue3 + ElementUI
+</td>
+<td align="center">
+<h4>📤 Easy Upload</h4>
+Support copy-paste and drag-drop
+</td>
+<td align="center">
+<h4>📦 Multiple Types</h4>
+Support text and various file types
+</td>
+</tr>
+<tr>
+<td align="center">
+<h4>🔒 Security</h4>

-## Project Status
+- IP upload limits
+- Error attempt limits
+- File expiration
+</td>
+<td align="center">
+<h4>🎫 Passcode Sharing</h4>
+Random codes with customizable limits
+</td>
+<td align="center">
+<h4>🌍 Multi-language</h4>
+Support for Simplified Chinese, Traditional Chinese, and English
+</td>
+</tr>
+<tr>
+<td align="center">
+<h4>🎭 Anonymous</h4>
+No registration required
+</td>
+<td align="center">
+<h4>🛠 Admin Panel</h4>
+File and system management
+</td>
+<td align="center">
+<h4>🐳 Docker</h4>
+One-click deployment
+</td>
+</tr>
+<tr>
+<td align="center">
+<h4>💾 Storage Options</h4>
+Local, S3, OneDrive support
+</td>
+<td align="center">
+<h4>📱 Responsive</h4>
+Mobile-friendly design
+</td>
+<td align="center">
+<h4>💻 CLI Support</h4>
+Command-line download
+</td>
+</tr>
+</table>

-![Alt](https://repobeats.axiom.co/api/embed/7a6c92f1d96ee57e6fb67f0df371528397b0c9ac.svg "Repobeats analytics image")
+## 🚀 Quick Start

-## Star History
+### Docker Deployment

-[![Star History Chart](https://api.star-history.com/svg?repos=vastsa/FileCodeBox&type=Date)](https://star-history.com/#vastsa/FileCodeBox&Date)
+```bash
+docker run -d --name filecode \
+  -p 12345:12345 \
+  -v /opt/filecode:/app/data \
+  --restart=always \
+  vastsa/filecode
+```

-## Disclaimer
+### Manual Deployment

-This project is open-sourced for learning purposes only and shall not be used for any illegal activities. Any consequences are the sole responsibility of the user and have no
-relation to the author. Please retain the project link when using. Thank you.
+1. Clone the repository
+```bash
+git clone https://github.com/vastsa/FileCodeBox.git
+```
+
+2. Install dependencies
+```bash
+cd FileCodeBox
+pip install -r requirements.txt
+```
+
+3. Start the service
+```bash
+python main.py
+```
+
+## 📖 Usage Guide
+
+### Share Files
+1. Open the website, click "Share File"
+2. Select or drag files
+3. Set expiration time and count
+4. Get the passcode
+
+### Retrieve Files
+1. Open the website, enter passcode
+2. Click retrieve
+3. Download file or view text
+
+### Admin Panel
+1. Visit `/admin`
+2. Enter admin password
+3. Manage files and settings
+
+## 🛠 Development Guide
+
+### Project Structure
+```
+FileCodeBox/
+├── apps/           # Application code
+│   ├── admin/     # Admin backend
+│   └── base/      # Base functions
+├── core/          # Core functions
+├── data/          # Data directory
+└── fcb-fronted/   # Frontend code
+```
+
+### Development Environment
+- Python 3.8+
+- Node.js 14+
+- Vue 3
+- FastAPI
+
+### Local Development
+1. Backend development
+```bash
+python main.py
+```
+
+2. Frontend development
+```bash
+cd fcb-fronted
+npm install
+npm run dev
+```
+
+## 🤝 Contributing
+
+1. Fork the project
+2. Create your feature branch `git checkout -b feature/xxx`
+3. Commit your changes `git commit -m 'Add xxx'`
+4. Push to the branch `git push origin feature/xxx`
+5. Open a Pull Request
+
+## ❓ FAQ
+
+### Q: How to modify upload size limit?
+A: Change `uploadSize` in admin panel
+
+### Q: How to configure storage engine?
+A: Select storage engine and configure parameters in admin panel
+
+### Q: How to backup data?
+A: Backup the `data` directory
+
+For more questions, visit [Wiki](https://github.com/vastsa/FileCodeBox/wiki/常见问题)
+
+## �� Project Statistics and Analytics
+
+<div align="center">
+<a href="https://hellogithub.com/repository/75ad7ffedd404a6485b4d621ec5b47e6" target="_blank"><img src="https://api.hellogithub.com/v1/widgets/recommend.svg?rid=75ad7ffedd404a6485b4d621ec5b47e6&claim_uid=beSz6INEkCM4mDH" alt="Featured｜HelloGitHub" style="width: 200px; height: 45px;" width="200" height="45" /></a>
+
+![Repobeats](https://repobeats.axiom.co/api/embed/7a6c92f1d96ee57e6fb67f0df371528397b0c9ac.svg)
+
+[![Star History](https://api.star-history.com/svg?repos=vastsa/FileCodeBox&type=Date)](https://star-history.com/#vastsa/FileCodeBox&Date)
+</div>
+
+## 📜 Disclaimer
+
+This project is open-source for learning purposes only. It should not be used for any illegal purposes. The author is not responsible for any consequences. Please retain the project address and copyright information when using it.