Introduce

In order to prosper the ecology of CabloyJS, Cabloy Store is provided. Cabloy Store includes a wide range of modules to meet the development needs of different scenarios

As a module user of Cabloy Store, you can freely combine all kinds of modules provided in Cabloy Store, and easily build an overall solution to meet your own needs

As a module provider of Cabloy Store, you can upload both free modules and paid modules

License Ways

Module providers are free to choose three license ways:

1. GitHub Repository

The GitHub repository link is provided in Cabloy Store, and module users can install the modules directly from the command line

2. Trial License

Trial License is provided in Cabloy Store, and module users can download the trial version of modules freely within the agreed time limit

There are the following options for the Trial License: Unlimited Trial, One Month, Tree Months, Six Months, One year

3. Official License

Official License is provided in Cabloy Store, and module users should purchase the Official Licence before downloading the official version of modules

There are the following options for the Official License: Unlimited License, One Month, Three Months, Six Months, One Year

The module provider may provide both Restricted License and Unlimited License and specify the License Fee respectively. For example, the License Fee is $10 for One Year, and $30 for Unlimited License

How to use module

For the modules downloaded from the Cabloy Store, it is recommended to use as follow:

  1. Create sub-path modules in the project root path
  2. Unzip the module, and move it to the path modules
  3. Run npm link in the command line
cd /path/to/project
npm link ./modules/{module name}

How to publish module

As a module provider, to publish modules in the Cabloy Store, need to go through the following steps:

1. Create Provider

In order to increase the business modules continuously and achieve a highly reusable effect, the namespace of all modules must be fully isolated, to avoid mutual pollution and conflict. Thus the naming convention is as follows:

egg-born-module-{providerId}-{moduleName}

Therefore, before publishing a module, you must first create a new provider, specify a globally unique Provider ID, and then submit it to the administrator for approval

It is strongly recommended to use the Username of GitHub as the Provider ID, so as to ensure that the modules contributed to the community will not conflict

Please go to Backend Admin Page to complete this operation

2. Create Module

When the new provider is approved, a new module can be created. When creating a new module, you can freely choose GitHub Repository, Trial License or Official License, and then submit them to the administrator for approval. When approved the new modules will be automatically published to the Cabloy Store

Please go to Backend Admin Page to complete this operation