From da95f178850e3adf55712db4146ffa8201fe5a5b Mon Sep 17 00:00:00 2001 From: "pikachu1995@126.com" Date: Tue, 20 Oct 2026 19:07:47 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0=E9=A1=B9=E7=9B=AE=20?= =?UTF-8?q?README=20=E4=B8=8E=E5=BC=80=E6=BA=90=E8=AE=B8=E5=8F=AF=E8=AF=B4?= =?UTF-8?q?=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- LICENSE | 682 ++------------------------------------------------- README.en.md | 268 +++++++++----------- README.md | 251 ++++++++++--------- 3 files changed, 272 insertions(+), 929 deletions(-) diff --git a/LICENSE b/LICENSE index 80a61fa12..9dfcd43ad 100644 --- a/LICENSE +++ b/LICENSE @@ -1,661 +1,21 @@ - GNU AFFERO GENERAL PUBLIC LICENSE - Version 3, 19 November 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU Affero General Public License is a free, copyleft license for -software and other kinds of works, specifically designed to ensure -cooperation with the community in the case of network server software. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -our General Public Licenses are intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - Developers that use our General Public Licenses protect your rights -with two steps: (1) assert copyright on the software, and (2) offer -you this License which gives you legal permission to copy, distribute -and/or modify the software. - - A secondary benefit of defending all users' freedom is that -improvements made in alternate versions of the program, if they -receive widespread use, become available for other developers to -incorporate. Many developers of free software are heartened and -encouraged by the resulting cooperation. However, in the case of -software used on network servers, this result may fail to come about. -The GNU General Public License permits making a modified version and -letting the public access it on a server without ever releasing its -source code to the public. - - The GNU Affero General Public License is designed specifically to -ensure that, in such cases, the modified source code becomes available -to the community. It requires the operator of a network server to -provide the source code of the modified version running there to the -users of that server. Therefore, public use of a modified version, on -a publicly accessible server, gives the public access to the source -code of the modified version. - - An older license, called the Affero General Public License and -published by Affero, was designed to accomplish similar goals. This is -a different license, not a version of the Affero GPL, but Affero has -released a new version of the Affero GPL which permits relicensing under -this license. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU Affero General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Remote Network Interaction; Use with the GNU General Public License. - - Notwithstanding any other provision of this License, if you modify the -Program, your modified version must prominently offer all users -interacting with it remotely through a computer network (if your version -supports such interaction) an opportunity to receive the Corresponding -Source of your version by providing access to the Corresponding Source -from a network server at no charge, through some standard or customary -means of facilitating copying of software. This Corresponding Source -shall include the Corresponding Source for any work covered by version 3 -of the GNU General Public License that is incorporated pursuant to the -following paragraph. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the work with which it is combined will remain governed by version -3 of the GNU General Public License. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU Affero General Public License from time to time. Such new versions -will be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU Affero General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU Affero General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU Affero General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU Affero General Public License as published - by the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU Affero General Public License for more details. - - You should have received a copy of the GNU Affero General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If your software can interact with users remotely through a computer -network, you should also make sure that it provides a way for users to -get its source. For example, if your program is a web application, its -interface could display a "Source" link that leads users to an archive -of the code. There are many ways you could offer source, and different -solutions will be better for different programs; see section 13 for the -specific requirements. - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU AGPL, see -. +MIT License + +Copyright (c) 2020-2026 Beijing Hongye Huicheng Technology Co., Ltd. (北京宏业汇成科技有限公司) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.en.md b/README.en.md index 4039d217e..b9ac0246d 100644 --- a/README.en.md +++ b/README.en.md @@ -1,184 +1,144 @@ -# Lilishop(Pickmall) - Java Open Source Mall System +
+ Lilishop Logo +

Lilishop(PickMall) - Web Frontend (Vue 3)

-[![GitHub Stars](https://img.shields.io/github/stars/hongyehuicheng/lilishop.svg?style=social&logo=github)](https://github.com/hongyehuicheng/lilishop) -[![Gitee Stars](https://gitee.com/beijing_hongye_huicheng/lilishop/badge/star.svg?theme=dark)](https://gitee.com/beijing_hongye_huicheng/lilishop) +

+ GitHub Stars + Gitee Stars + License + Vue 3 + Element Plus + Pinia +

-

- 简体中文 | English -

+

+ 🏠 Official Website · + 📖 Product Documentation · + 💻 Online Demo · + 💻 GitHub +

-LiliShop is a Java open source ecommerce system built with Spring Boot, Spring Cloud, Vue, and Uniapp. +

+ 简体中文 | English +

+
-It supports: +> ⭐ **If you like this project, please click `Star` in the top-right corner to support us! Your Star is our greatest motivation for continuous open-source iteration!** -- B2B2C multi-vendor marketplace -- Microservice architecture -- WeChat mini program -- Vue ecommerce frontend -- Uniapp mobile app -- Live streaming ecommerce -- Distribution & affiliate system -- Flash sale / coupon / promotion -- Docker deployment -- Private deployment -- Multi-language ecommerce platform +**LILISHOP** is an open-source e-commerce system built with Spring Boot, Vue 3, and uni-app. It supports B2B2C multi-vendor marketplaces, WeChat Mini Programs, H5, Android/iOS Apps, live-streaming e-commerce, affiliate distribution, and flash sales. + +### ✨ Why Choose Lilishop +- 🟢 **True MIT License**: Free for commercial use and private secondary development without licensing concerns. +- 🚀 **Modern Vue 3 Stack**: Built on `Vue 3.5 + Pinia 4 + Vue Router 4 + Element Plus`, leaving legacy Vue 2 templates behind. +- 🧩 **4-in-1 Production Suite**: Covers **PC Buyer Mall (`buyer`)**, **Seller Portal (`seller`)**, **Platform Admin Panel (`manager`)**, and **IM Customer Service Web (`im`)**, complete with drag-and-drop visual storefront decoration and rich analytics. --- -## Keywords +## 1. Overview -Java Mall System -Open Source Ecommerce Platform -Spring Boot Mall System -Spring Cloud Ecommerce -B2B2C Marketplace -Multi Vendor Ecommerce Platform -Vue Ecommerce System -Uniapp Mall System -Microservice Mall System -Wechat Mini Program Mall -Docker Ecommerce Deployment +This repository (`lilishop-ui`) is the **Web Frontend Suite** of Lilishop, containing four standalone **Vue 3** web applications: **PC Buyer Mall, Seller Panel, Platform Admin Panel, and IM Customer Service Web**. + +- **Official Website**: +- **Documentation**: [Product Documentation](https://bdwx2tfwwt.feishu.cn/wiki/space/7675179368632617952?ccm_open_type=lark_wiki_spaceLink&open_tab_from=wiki_home) +- **Gitee Repository**: +- **GitHub Main Repository**: --- -## Official Website +## 2. Online Demo -- Website: https://pickmall.cn -- Documentation: https://docs.pickmall.cn -- GitHub: https://github.com/lilishop/lilishop -- Gitee: https://gitee.com/beijing_hongye_huicheng/lilishop +> **Note**: The verification code for the demo environment is `111111`. + +| Portal | URL | Demo Credentials | +| :--- | :--- | :--- | +| **Platform Admin Panel (`manager`)** | | `admin` / `123456` | +| **Seller / Store Panel (`seller`)** | | `13011111111` / `111111` | +| **PC Buyer Mall (`buyer`)** | | SMS code: `111111` | +| **Mobile H5 (`uni-app`)** | | SMS code: `111111` | + +| WeChat Mini Program | Mobile H5 ([Visit Directly](https://m-b2b2c.pickmall.cn)) | +| :---: | :---: | +| WeChat Mini Program QR Code | Mobile H5 QR Code | +| Scan with WeChat | Scan or visit | --- -## Core Features +## 3. Core Features & Tech Stack -### Full Platform Support +### Core Features +- **Four-Portal Synergy**: Includes Platform Admin, Seller Panel, PC Buyer Mall, and IM Web Workbench with clear role boundaries. +- **Drag-and-Drop Visual Decoration**: Built-in visual floor editor (`vuedraggable`) for customizing both PC and mobile storefronts. +- **Multi-Vendor B2B2C Operations**: Merchant onboarding, product auditing, split-order fulfillment, promotions, and financial settlement ledgers. +- **Rich Business Analytics**: Powered by `@antv/g2` for sales overview, YoY/MoM product reports, member analytics, and distribution metrics. +- **IM Customer Service**: Integrated with Tencent Cloud IM / WebSocket customer service for real-time communication. -One codebase supports: - -- PC -- H5 -- WeChat Mini Program -- Android APP -- iOS APP - -### Microservice Architecture - -Built with: - -- Spring Boot -- MySQL -- Redis -- Docker - -Supports standalone deployment: **buyer-api** (8888), **manager-api** (8887, includes store APIs), **im-api** (8885). Product search uses MySQL. Async messaging uses Redis queues. Scheduled tasks use Spring `@Scheduled`. - -### Frontend API paths - -| App | Public API prefix | -| :--- | :--- | -| Buyer | `{buyerUrl}/buyer/common/*` | -| Seller | `{sellerUrl}/store/common/*` | -| Manager | `{managerUrl}/manager/common/*` | - -The legacy `common-api` and `/common/common/*` paths are removed. - -### Ecommerce Features - -- Multi merchant marketplace -- Product management -- Order management -- Promotion system -- Coupon system -- Affiliate distribution -- Live streaming ecommerce -- Member system -- Points system -- Visual decoration -- Multi-language support +### Web Tech Stack +| Category | Technology | Description | +| :--- | :--- | :--- | +| Core Framework | `Vue 3.5` + `Vue Router 4` | Modern reactive frontend framework | +| State Management | `Pinia 4` | Official Vue 3 state management library | +| UI Library | `Element Plus 2.x` | Enterprise desktop UI component library | +| HTTP Client | `Axios 1.x` | Unified request/response interceptors & auth handling | +| Data Visualization | `@antv/g2` | Interactive charts and business analytics | +| Visual Decoration | `vuedraggable 4` | Drag-and-drop page floor builder | +| Messaging & IM | `@tencentcloud/chat` / `sockjs-client` | Real-time customer service messaging | +| Video Player | `dplayer` + `hls.js` | Product video and live streaming playback | +| Build & Styling | `Vue CLI 5` + `Webpack 5` + `Sass / Less` | Modular build pipeline and theme customization | --- -## Tech Stack +## 4. Directory Structure -### Backend - -- Java 21 -- Spring Boot 4 -- MyBatis Plus -- MySQL -- Redis -- JWT -- Docker - -### Frontend - -- Vue.js -- Uniapp -- Vuex -- Axios -- iView -- uViewUI +```text +lilishop-ui +├── buyer/ # [PC Buyer Mall] +│ ├── public/ # Static assets & global config (config.js) +│ └── src/ +│ ├── api/ # Buyer API modules (goods, cart, order, member, promotion) +│ ├── components/ # Shared components (floor renderer, navbar, goods card) +│ ├── pages/ # PC Mall pages (Home, Product Detail, Checkout, User Center) +│ ├── router/ # Route definitions & guards +│ ├── stores/ # Pinia stores +│ └── utils/ # Request interceptors & helpers +├── seller/ # [Seller / Store Management Portal] +│ ├── public/ # Static assets & global config +│ └── src/ +│ ├── api/ # Seller API modules +│ ├── components/ # Seller shared & decoration components +│ ├── views/ # Seller views (goods, orders, after-sales, promotions, store settings) +│ ├── router/ # Dynamic permission routes +│ └── stores/ # Pinia stores +├── manager/ # [Platform Admin Portal] +│ ├── public/ # Static assets & global config +│ └── src/ +│ ├── api/ # Admin API modules +│ ├── components/ # Admin components, rich-text editor, visual floor builder +│ ├── views/ # Admin views (member, goods, order, seller, marketing, finance, stats, system) +│ ├── router/ # Menu & permission routes +│ └── stores/ # Pinia stores +├── im/ # [IM Customer Service Web Client] +│ └── src/ +│ ├── api/ # Chat session & message APIs +│ ├── components/ # Chat window, message list, product/order cards +│ ├── im-server/ # WebSocket / IM connection manager +│ └── views/ # Customer service workbench +├── build.sh # Unified build script +└── docker-build.sh # Docker image build script +``` --- -## Online Demo +## 5. Related Repositories -### Admin Panel - -https://admin-b2b2c.pickmall.cn - -Account: admin -Password: 123456 - -### Store Panel - -https://store-b2b2c.pickmall.cn - -Account: 13011111111 -Password: 111111 - -### PC Mall - -https://pc-b2b2c.pickmall.cn +| Repository | Description | Links | +| :--- | :--- | :--- | +| **`lilishop`** | Backend Services (Spring Boot 4 / Java 21) | [Gitee](https://gitee.com/beijing_hongye_huicheng/lilishop) · [GitHub](https://github.com/lilishop/lilishop) | +| **`lilishop-ui`** | PC Mall / Seller / Admin / IM Web Frontend | [Gitee](https://gitee.com/beijing_hongye_huicheng/lilishop-ui) | +| **`lilishop-uniapp`** | Mobile Buyer Client (H5 / Mini Program / App) | [Gitee](https://gitee.com/beijing_hongye_huicheng/lilishop-uniapp) | +| **`docker`** | Docker Compose, Images & SQL Init Scripts | [Gitee](https://gitee.com/beijing_hongye_huicheng/docker) · [MySQL Scripts](https://gitee.com/beijing_hongye_huicheng/docker/tree/master/init/mysql) | --- -## Quick Start +## 6. License -Please read the deployment documentation: - -https://docs.pickmall.cn - -Supports: - -- Docker deployment -- Linux deployment -- Kubernetes deployment -- Microservice deployment - ---- - -## FAQ - -### Is PickMall open source? - -Yes. PickMall is an open source Java ecommerce system. - -### Does PickMall support microservices? - -Yes. PickMall is built on Spring Cloud microservice architecture. - -### Does PickMall support Docker? - -Yes. Docker deployment is supported. - -### Does PickMall support WeChat Mini Program? - -Yes. It supports WeChat Mini Program and Uniapp. - ---- - -## License - -PickMall is licensed under AGPL-3.0. \ No newline at end of file +Lilishop is licensed under the [MIT](./LICENSE) License. Copyright © 2020-2026 **Beijing Hongye Huicheng Technology Co., Ltd.** diff --git a/README.md b/README.md index b9397c510..52600007b 100644 --- a/README.md +++ b/README.md @@ -1,158 +1,181 @@ -# Lilishop(PickMall) 开源商城系统 +
+ Lilishop Logo +

Lilishop(PickMall) 开源商城系统 - Web 前端 (Vue 3)

-[![GitHub Stars](https://img.shields.io/github/stars/lilishop/lilishop.svg?style=social&logo=github)](https://github.com/lilishop/lilishop) -[![Gitee Stars](https://gitee.com/beijing_hongye_huicheng/lilishop/badge/star.svg?theme=dark)](https://gitee.com/beijing_hongye_huicheng/lilishop) -[![License](https://img.shields.io/badge/license-AGPL--3.0-blue.svg)](./LICENSE) -[![Vue](https://img.shields.io/badge/Vue-3-brightgreen.svg)](https://vuejs.org/) +

+ GitHub Stars + Gitee Stars + License + Vue 3 + Element Plus + Pinia +

-

- 简体中文 | English -

+

+ 🏠 官方网站 · + 📖 产品文档 · + 💻 在线演示 · + 💬 微信交流群 +

+

+ 简体中文 | English +

+
-LILISHOP 是基于 Spring Boot / Spring Cloud / Vue / Uniapp 开发的 Java 开源商城系统，支持 B2B2C 多商户商城、小程序商城、微服务商城、直播电商、分销返佣、秒杀活动、Docker 私有化部署。 +> ⭐ **如果觉得项目不错，请点击右上角 `Star` 收藏支持！您的 Star 是我们持续开源迭代的最大动力！** -## 核心特性 +**LILISHOP** 是基于 Spring Boot / Vue 3 / uni-app 开发的开源商城系统，支持 B2B2C 多商户商城、微信小程序商城、H5 商城、APP 商城、直播电商、分销返佣、秒杀活动。 -- Java商城系统 -- 开源商城系统 -- Spring Boot 4商城系统 -- SpringCloud微服务商城 -- B2B2C商城源码 -- 多商户商城系统 -- 小程序商城源码 -- Uniapp商城系统 -- Vue商城系统 -- Docker商城部署 -- 多语言商城 - -适用于： - -- 企业级商城系统 -- 私有化商城部署 -- Java商城系统二次开发 -- 开源商城源码学习 -- 多商户电商平台 ---- - -### 1. 项目简介 - -**Lilishop** 是一款功能完善的B2B2C多商户商城系统，采用前后端分离架构，全端代码开源。 -后端基于 **Spring Boot 4**（Java 21）构建，具备高内聚、低耦合的特性，支持分布式部署。 -前端覆盖PC、H5、小程序和APP，基于 **Vue** 和 **uni-app** 开发。 - -- **官方网站**: -- **官方文档**: -- **Gitee 仓库**: -- **GitHub 仓库**: - -本仓库为 **PC / 商家端 / 运营端 / IM Web** 源码（`lilishop-ui`）。 +### ✨ 为什么选择 Lilishop +- 🟢 **真 MIT 协议**：支持免费商用与私有化闭源二开，无版权后顾之忧。 +- 🚀 **Vue 3 全新栈**：全面基于 `Vue 3.5 + Pinia 4 + Vue Router 4 + Element Plus` 构建，告别老旧 Vue 2 架构。 +- 🧩 **四端合一生产级闭环**：完整覆盖 **PC 买家端 (`buyer`)**、**商家端 (`seller`)**、**平台运营管理端 (`manager`)** 与 **在线客服端 (`im`)**，支持拖拽式可视化楼层装修与多维数据统计报表。 --- -### 2. 核心特性 +## 1. 项目简介 -- **全端覆盖**: 一套代码库支持PC、H5、小程序、APP，降低开发和维护成本。 -- **商家入驻**: 支持多商家入驻，构建平台化电商生态。 -- **分布式架构**: 后端API服务化，支持独立部署和弹性伸缩。 -- **前后端分离**: 清晰的职责划分，便于团队协作和独立开发。 -- **容器化支持**: 提供Docker镜像和docker-compose配置，实现一键部署。 -- **功能完善**: 涵盖客户、订单、商品、促销、店铺、运营、统计等完整电商业务模块。 +**Lilishop** 是一款功能完善的 B2B2C 多商户商城系统，采用前后端分离架构，全端代码开源。 +后端基于 **Spring Boot 4**（Java 21）构建，具备高内聚、低耦合的特性，支持分布式部署；前端覆盖 PC、管理后台、H5、小程序和 APP，基于 **Vue 3** 和 **uni-app** 开发。 + +本仓库（`lilishop-ui`）为 **Web 前端源码仓库**，包含 **PC 商城端、商家后台、平台管理后台、IM 在线客服** 四个独立子工程。 + +- **官方网站**: +- **官方文档**: [产品文档](https://bdwx2tfwwt.feishu.cn/wiki/space/7675179368632617952?ccm_open_type=lark_wiki_spaceLink&open_tab_from=wiki_home) +- **Gitee 仓库**: +- **GitHub 主仓库**: --- -### 3. 在线演示 +## 2. 在线演示 -**注意**: 演示站手机验证码统一为 `111111`。演示环境部署于 `master` 分支。 +> **注意**: 演示站手机验证码统一为 `111111`。演示环境部署于 `master` 分支。 -- **平台管理端**: - - 账号: `admin` - - 密码: `123456` -- **店铺管理端**: - - 账号: `13011111111` - - 密码: `111111` -- **商城PC端**: -- **微信小程序**: - ![移动端体验二维码](https://static.pickmall.cn/images/h5-qrcode.png) +| 演示站点 | 访问地址 | 演示账号 | +| :--- | :--- | :--- | +| **平台运营管理端 (`manager`)** | | 账号：`admin` / 密码：`123456` | +| **商家店铺管理端 (`seller`)** | | 账号：`13011111111` / 密码：`111111` | +| **商城 PC 买家端 (`buyer`)** | | 可使用手机号验证码 `111111` 登录 | +| **移动端 H5 (`uni-app`)** | | 可使用手机号验证码 `111111` 登录 | + +| 微信小程序 | 移动端 H5（[点击直接访问](https://m-b2b2c.pickmall.cn)） | +| :---: | :---: | +| 微信小程序体验码 | 移动端 H5 体验二维码 | +| 微信扫码体验小程序 | 手机扫码或访问 | --- -### 4. 快速开始 +## 3. 核心特性与技术栈 -#### 环境准备与部署 -详细的本地部署指南，请参考官方文档： -[**部署文档 -> 环境准备**](https://docs.pickmall.cn/deply/deply.html) +### 核心特性 +- **四端协同**: 涵盖平台管理端、商家管理端、PC 买家商城端、IM 客服端，角色边界清晰，开箱即用。 +- **可视化拖拽装修**: 管理端与商家端内置可视化楼层编辑器（基于 `vuedraggable`），可同步配置 PC 端与移动端首页/专题页。 +- **多商户入驻与结算**: 完整的商家入驻审核、商品审核、拆单发货、促销报名、财务对账与结算台账体系。 +- **多维经营分析**: 集成 `@antv/g2` 图表引擎，提供营业概况、商品同比环比、会员分析、营销与分销数据统计。 +- **即时通讯客服**: 集成腾讯云 IM / WebSocket 在线客服系统，支持买家、商家与平台实时沟通。 -#### 数据库初始化 -- **推荐方式**: 使用项目提供的 `docker-compose` 配置，可自动完成数据库（MySQL、Redis 等）的部署与初始化。 -- **手动方式**: 如果您选择手动部署，SQL脚本位于以下地址。请确保获取与您代码版本一致的SQL文件。 - [**数据库脚本 (Gitee)**](https://gitee.com/beijing_hongye_huicheng/docker/tree/master/init/mysql) +### Web 前端技术栈 +| 类别 | 技术选型 | 说明 | +| :--- | :--- | :--- | +| 核心框架 | `Vue 3.5` + `Vue Router 4` | 基于 Composition API 的现代响应式前端框架 | +| 状态管理 | `Pinia 4` | 轻量、类型友好的 Vue 3 官方状态管理库 | +| UI 组件库 | `Element Plus 2.x` | 企业级中后台与桌面端 UI 组件库 | +| 网络请求 | `Axios 1.x` | 统一请求/响应拦截、Token 刷新与异常提示 | +| 数据可视化 | `@antv/g2` | 运营端与商家端数据统计图表渲染 | +| 可视化拖拽 | `vuedraggable 4` | 商城首页及专题楼层可视化拖拽装修 | +| 即时通讯 | `@tencentcloud/chat` / `sockjs-client` | 在线客服消息收发与实时通知 | +| 音视频播放 | `dplayer` + `hls.js` | 商品视频与直播流播放支持 | +| 构建与样式 | `Vue CLI 5` + `Webpack 5` + `Sass / Less` | 模块化工程构建与全局主题样式定制 | --- -### 5. 架构文档边界 +## 4. 目录结构 -本仓库首页不再维护不完整的系统架构图和技术栈表，避免与实际源码、部署形态和分支差异产生偏差。当前仓库主要说明 PC / 商家端 / 运营端 / IM Web 前端源码定位、在线演示和部署入口。 - -完整架构请以官方文档及四个源码仓库为准： - -- 后端源码：`lilishop` -- PC / 商家端 / 运营端 / IM Web：`lilishop-ui` -- H5 / 小程序 / APP：`lilishop-uniapp` -- 部署、SQL、镜像与启动脚本：`docker` +```text +lilishop-ui +├── buyer/ # 【PC 买家商城端】源码工程 +│ ├── public/ # 静态资源与全局配置文件 (config.js) +│ └── src/ +│ ├── api/ # 买家端接口定义（商品、购物车、订单、会员、促销等） +│ ├── components/ # 公共业务组件（楼层渲染、导航栏、商品卡片等） +│ ├── pages/ # PC 商城各业务页面（首页、商品详情、结算、个人中心等） +│ ├── router/ # 路由配置与守卫 +│ ├── stores/ # Pinia 状态管理 +│ └── utils/ # 请求封装与通用工具函数 +├── seller/ # 【商家店铺管理端】源码工程 +│ ├── public/ # 静态资源与全局配置 +│ └── src/ +│ ├── api/ # 商家端接口定义 +│ ├── components/ # 商家端公共组件与装修组件 +│ ├── views/ # 商家端业务视图（商品管理、订单发货、售后、促销、店铺设置、统计等） +│ ├── router/ # 动态权限路由 +│ └── stores/ # Pinia 状态管理 +├── manager/ # 【平台运营管理端】源码工程 +│ ├── public/ # 静态资源与全局配置 +│ └── src/ +│ ├── api/ # 运营端接口定义 +│ ├── components/ # 平台公共组件、富文本、可视化楼层装修编辑器 +│ ├── views/ # 运营端业务视图（会员、商品、订单、商家、营销、分销、财务、统计、系统设置） +│ ├── router/ # 菜单与权限路由 +│ └── stores/ # Pinia 状态管理 +├── im/ # 【IM 在线客服 Web 端】源码工程 +│ └── src/ +│ ├── api/ # 客服会话与消息接口 +│ ├── components/ # 聊天窗口、消息列表、商品/订单卡片组件 +│ ├── im-server/ # WebSocket / IM 连接服务管理 +│ └── views/ # 客服工作台页面 +├── build.sh # 多端统一构建脚本 +└── docker-build.sh # Docker 镜像构建脚本 +``` --- -### 6. 功能列表 +## 5. 配套源码仓库 -[功能清单](https://bdwx2tfwwt.feishu.cn/sheets/FFQKscQKDhUx60to1k9cbMngnYb?from=from_copylink) +本仓库专注于 **PC / 商家端 / 运营端 / IM Web**（`lilishop-ui`）。完整系统由以下四个核心仓库组成： + +| 仓库名称 | 职责说明 | 仓库地址 | +| :--- | :--- | :--- | +| **`lilishop`** | 后端服务源码（Spring Boot 4 / Java 21） | [Gitee](https://gitee.com/beijing_hongye_huicheng/lilishop) · [GitHub](https://github.com/lilishop/lilishop) | +| **`lilishop-ui`** | PC 商城 / 商家端 / 运营管理端 / IM Web 前端 | [Gitee](https://gitee.com/beijing_hongye_huicheng/lilishop-ui) | +| **`lilishop-uniapp`** | 买家端 H5 / 微信小程序 / Android & iOS APP | [Gitee](https://gitee.com/beijing_hongye_huicheng/lilishop-uniapp) | +| **`docker`** | 容器化部署编排、镜像与数据库脚本 | [Gitee](https://gitee.com/beijing_hongye_huicheng/docker) · [MySQL 脚本](https://gitee.com/beijing_hongye_huicheng/docker/tree/master/init/mysql) | --- -### 7. 开源与授权 +## 6. 开源与授权 -1. **开源协议**: 本项目遵循 `AGPL-3.0` 开源协议。 -2. **使用范围**: 仅允许用于个人学习、研究和非商业用途。 -3. **禁止行为**: 禁止将本项目的代码和资源用于任何形式的商业销售。 -4. **商业授权**: 如需商业使用，必须获得官方授权。授权为一次性永久授权，并提供持续的版本升级服务。详情请联系官网客服。 -5. **软件著作权**: 本软件受国家计算机软件著作权保护（登记号：2021SR0805085）。 +本项目遵循 [MIT](./LICENSE) 开源协议，版权归 **北京宏业汇成科技有限公司** 所有。允许个人及企业免费用于学习、研究、修改和商业用途（需保留原始版权和许可声明）。 --- -### 8. 社区与支持 +## 7. 社区与支持 -我们欢迎任何形式的交流与贡献。在提问前，请先查阅 [官方文档](https://docs.pickmall.cn/) ，并参考 [《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/master/README-zh_CN.md) 以便高效沟通。 +我们欢迎任何形式的交流与贡献。在提问前，请先查阅 [产品文档](https://bdwx2tfwwt.feishu.cn/wiki/space/7675179368632617952?ccm_open_type=lark_wiki_spaceLink&open_tab_from=wiki_home)，并参考 [《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/master/README-zh_CN.md) 以便高效沟通。 -- **[在线客服](https://work.weixin.qq.com/kfid/kfc4d8dc24a73c15f44)** -- **微信交流群**: - ![微信群](https://lilishop-wechat.oss-cn-beijing.aliyuncs.com/wechat.jpg) +- **[在线客服](https://work.weixin.qq.com/kfid/kfc4d8dc24a73c15f44)** +- **微信交流群**: + 微信群 --- -### 9. 升级计划 +## 8. 升级计划 -以下功能将陆续在后续版本中发布：✅ 已完成 · 🔜 规划中 +### ✅ 已完成特性 +| 功能模块 | 功能模块 | +| :--- | :--- | +| ✅ 商品定时上下架 | ✅ 商品分组 / 会员分组 | +| ✅ 商品虚拟销量 | ✅ 专用发票（发票上传） | +| ✅ 置顶评论 | ✅ 客户等级体系 | +| ✅ 购物卡 | ✅ 腾讯云-云直播 | +| ✅ 卡密商品 | ✅ 二级分销 | +| ✅ 定时任务管理 | ✅ 预约服务商品 | +| ✅ 主题色管理 | ✅ 商家发货改造（整单/拆单/无需配送） | +| ✅ 多维统计（营业/商品/会员/积分/储值/营销/分销） | ✅ 经营报表（店铺业绩/商品同比环比/订单明细/销售汇总） | -- ✅ 商品定时上下架 -- ✅ 商品分组 -- ✅ 会员分组 -- ✅ 商品虚拟销量 -- ✅ 专用发票（发票上传） -- ✅ 置顶评论 -- ✅ 客户等级 -- ✅ 购物卡 -- ✅ 腾讯云-云直播 -- ✅ 统计：营业概况、商品概况、会员概况、积分分析、储值分析、营销概况、分销统计 -- ✅ 经营报表（店铺业绩报表、商品同比环比报表、销售订单明细报表、商品销售汇总报表） -- ✅ 卡密商品 -- ✅ 二级分销 -- ✅ 定时任务管理 -- ✅ 服务商品 -- ✅ 主题色管理 -- 🔜 店铺结算汇总 -- 🔜 支付方式汇总 -- 🔜 结算台账 -- 🔜 钱包流水 -- 🔜 财务汇总 +### 🔜 近期规划中 +- 🔜 店铺结算汇总 & 结算台账 +- 🔜 支付方式汇总 & 钱包流水 & 财务汇总 - 🔜 微信小店对接 - 🔜 抖店对接