Skip to content

Latest commit

 

History

History
119 lines (88 loc) · 3.82 KB

README_EN.md

File metadata and controls

119 lines (88 loc) · 3.82 KB

TByd UPM

License Platform Flutter

A Flutter-based UPM private registry management tool, specifically designed for managing and maintaining Verdaccio-based private UPM registries.

👥 Authors & Maintainers

  • Lead Developer: TianYu - TByd Team
  • Technical Support: TByd Technical Support
  • Email: [email protected]
  • Homepage: GitHub

✨ Features

🚀 Core Features

  • 🔗 Connect to Alibaba Cloud Verdaccio Registry
  • 🔍 Package browsing and search functionality
  • 📦 Package version management
  • ⬆️ Package publishing and deletion
  • 📝 Package metadata viewing and editing
  • 📅 Version history tracking

🎨 User Interface

  • 💫 Modern Material Design interface
  • 📱 Responsive layout for different window sizes
  • 🌓 Light/Dark theme support
  • 🎯 Customizable workspace layout
  • ⌨️ Keyboard shortcuts support

🔒 Security Features

  • 🛡️ Secure authentication mechanism
  • 🔐 Encrypted credential storage
  • 📋 Operation audit logging
  • 👥 Permission management system

⚡ Performance Optimization

  • 🔄 Asynchronous loading mechanism
  • 💾 Smart caching system
  • 📊 Background task queue

💻 System Requirements

  • 🪟 Windows 10 or higher
  • 🔲 CPU: Dual-core or better
  • 💿 Memory: 4GB or more
  • 💽 Storage: 500MB available space
  • 🖥️ Display: 1280x720 or higher resolution

🚀 Quick Start

  1. ⬇️ Download the latest version installer
  2. 🏃 Run the setup program
  3. 📱 Launch the application
  4. ⚙️ Configure Verdaccio server address and authentication
  5. ✨ Start using

📖 User Guide

⚙️ Basic Configuration

  1. Server Setup

    • 🔗 Enter Verdaccio server address
    • 🔑 Configure user authentication
    • 🌐 (Optional) Set up proxy

  2. 📦 Package Management

    • 🔍 Browse and search packages
    • 📋 View package details and version history
    • ⬆️ Publish new or update existing packages
    • 🗑️ Delete packages or specific versions

🎯 Advanced Features

  • 📦 Batch operation support
  • 🎨 Custom workspace layout
  • ⌨️ Keyboard shortcut configuration
  • 🌓 Theme switching

🤝 Contributing

We welcome community contributions. Please follow these steps:

  1. 🔱 Fork the project
  2. 🌿 Create your feature branch (git checkout -b feature/AmazingFeature)
  3. 📝 Commit your changes (git commit -m 'Add some AmazingFeature')
  4. 🚀 Push to the branch (git push origin feature/AmazingFeature)
  5. 🎯 Open a Pull Request

📄 License

Copyright © 2024 TByd Team. All rights reserved.

💁 Support

If you encounter any issues while using the software, please get support through the following channels:

  1. 📧 Send email to [email protected]
  2. 🐛 Submit an Issue on GitHub
  3. 👥 Join our technical support group (please request invitation link via email)

💡 Feedback & Suggestions

We highly value your experience and suggestions. If you have any improvement ideas or feature requests, please let us know through:

  1. 📝 Send detailed suggestions to our email
  2. 🎯 Submit suggestions with "enhancement" label on GitHub Issues
  3. 📊 Participate in our user surveys (conducted periodically)

🔍 Issue Reporting Guide

When you encounter issues, please provide the following information to help us better assist you:

  1. 📌 Software version
  2. 💻 Operating system version
  3. 📝 Detailed description of the issue
  4. 🔄 Steps to reproduce
  5. ❌ Error messages or screenshots (if any)
  6. ✅ Expected behavior