aseqbase/shop

To create a new Shop, with all accessibility and equipment, for an aseqbase website...

v4.0.0 2025-09-20 15:08 UTC

Requires

• composer/installers: ^1.12

GPL-3.0-only

• Mohammad Fathi
• Martin Fixoni
• Jacoob Del Pano

README

aseqbase/shop

The objective is to establish a fully functional and readily accessible Shop, complete with all necessary equipment and resources, specifically designed for seamless integration within the existing framework of the aseqbase website. This involves careful planning and execution to ensure that the new Shop is not only user-friendly but also adheres to the highest standards of accessibility, allowing all visitors to navigate and utilize its features effectively. The provision of appropriate equipment is paramount to the Shop's operational efficiency, guaranteeing a smooth and productive workflow for both administrators and customers alike, ultimately enhancing the overall user experience on the aseqbase website.

Dependencies

• aseqbase/aseqbase

Managements

Installing

1. Install all dependencies mentioned before
2. Follow one of these options:
   • Open a terminal in the destination directory (for example, D:\MyWebsite\shop\) of the website, then install the project by:

      > composer create-project aseqbase/shop

   • Prompts below to create a manageable project (update, uninstall, etc.):

      > composer require aseqbase/shop
      > cd vendor/aseqbase/shop
      vendor/aseqbase/shop> composer dev:install

3. Put the destination directory of your project on the appeared step (for example, D:\MyWebsite\shop\)

     Destination Directory [D:\MyWebsite\]: D:\MyWebsite\shop\

4. Follow the steps to finish the installation of sources, database, etc.
5. [optional] On the local server, create an optional file named global.php in the shop directory to change your-parent-directory-name (from the .aseq) using:

     > composer shop:create global --aseq "shop" --base "your-parent-directory-name" -f

   or

     > cd vendor/aseqbase/shop
     vendor/aseqbase/shop> composer dev:create global --aseq "shop" --base "your-parent-directory-name" -f

   Note: Do not forget to replace "your-parent-directory-name" with your item (default .aseq).
6. Enjoy...

Using

1. Do one of the following options:
   • Visit its special URL (for example, http://shop.[my-domain-name].com, or http://[my-domain-name].com/shop)
   • On the local server:
     1. Use the following command on the root directory

        > composer start

     2. Visit the URL localhost:8000 (for default) on the local browser
2. Enjoy...

Updating

1. Keep your project updated using

     > composer shop:update

   or

     > cd vendor/aseqbase/shop
     vendor/aseqbase/shop> composer dev:update

2. Follow the steps to finish the update of sources, database, etc.
3. Enjoy...

Uninstalling

1. Uninstall the project and the constructed database using:

     > composer shop:unistall

   or

     > cd vendor/aseqbase/shop
     vendor/aseqbase/shop> composer dev:unistall

2. Follow the steps to finish the uninstallation of sources, database, etc.
3. Enjoy...

Creating

1. Create a new file by a predefined template name (for example, global, config, back, router, front, user, info, etc.) using:

     > composer shop:create [predefined-template-name]

   or

     > cd vendor/aseqbase/shop
     vendor/aseqbase/shop> composer dev:create [predefined-template-name]

2. Follow the steps to finish creating the file.
3. Enjoy...