Lunar Documentation

repository·1.x·Indexed 25 days ago

An e-commerce engine for Laravel providing a complete backend suite, including core e-commerce logic and a Filament-based admin panel. Lunar allows developers to build custom storefronts using a monorepo structure consisting of a Core package for models and utilities, and an Admin panel for managing products, orders, and staff.

Tokens: 1.2K
Snippets: 1
Records: 14
Agent score: 86%

What's inside Lunar

Overview of Lunar Meilisearch
1.x
Lunar Meilisearch is a package designed to index filterable and sortable attributes using the Meilisearch search engine.
https://github.com/lunarphp/lunar/blob/1.x/packages/meilisearch/README.md
Overview of Lunar
1.x
Lunar is a set of Laravel packages designed to provide e-commerce functionality (similar to Shopify) within the Laravel ecosystem. It provides a robust backend for managing stores, allowing developers to build custom storefronts while leveraging pre-built e-commerce logic.
https://github.com/lunarphp/lunar/blob/1.x/README.md
Understand the Lunar Monorepo structure
1.x
Lunar is distributed as a monorepo containing several key components:
- Core: The essential package containing all models, actions, and utilities required for store functionality. This package is a prerequisite for the Admin panel.
- Admin panel: A modern management interface built using Filament. It allows for the management of products, orders, staff members, and other store aspects. It is designed to be extensible to meet specific store requirements.
https://github.com/lunarphp/lunar/blob/1.x/README.md
Configure the cart pruning pipeline
1.x
The lunar:prune:carts command processes carts through a pipeline defined in your configuration. You can add custom logic or filters to the pruning process by adding pipelines to the lunar.cart.prune_tables.pipelines configuration key.
https://github.com/lunarphp/lunar/blob/1.x/packages/core/src/Console/Commands/PruneCarts.php
Meilisearch setup requirement for lunar:search:index
1.x
If your Laravel Scout configuration is set to use the meilisearch driver, ensure you have installed and set up the lunarphp/meilisearch package. The lunar:search:index command will issue a warning if the lunar:meilisearch:setup command is not available in your application.
https://github.com/lunarphp/lunar/blob/1.x/packages/core/src/Console/Commands/ScoutIndexerCommand.php
Reference: lunar:create-admin flags
1.x
The following flags are available for the lunar:create-admin command. If omitted, the command will prompt you for the information interactively.
```
--firstname= : The first name of the user
--lastname= : The last name of the user
--email= : A valid and unique email address
--password= : The password for the user (min. 8 characters)
```
https://github.com/lunarphp/lunar/blob/1.x/packages/admin/src/Console/Commands/MakeLunarAdminCommand.php
Reference: lunar:search:index command options
1.x
The lunar:search:index command supports the following arguments and options:
https://github.com/lunarphp/lunar/blob/1.x/packages/core/src/Console/Commands/ScoutIndexerCommand.php
Import address data via lunar:import:address-data
1.x
Use the lunar:import:address-data command to import country and state data into your Lunar installation. This command fetches the latest country and state information from http://data.lunarphp.io/countries+states.json and populates the Country and associated State models. It automatically skips countries that already exist in your database based on their iso3 code.
https://github.com/lunarphp/lunar/blob/1.x/packages/core/src/Console/Commands/Import/AddressData.php
Discover available addons with lunar:addons:discover
1.x
Use the lunar:addons:discover command to rebuild the cached addon package manifest. This command scans for available addons and generates a fresh manifest file, which is useful when new addons have been added to the project or when the manifest needs to be refreshed.
https://github.com/lunarphp/lunar/blob/1.x/packages/core/src/Console/Commands/AddonsDiscover.php
Migrate GetCandy into Lunar
1.x
Use the lunar:migrate:getcandy command to migrate data from a GetCandy installation into Lunar.
This command performs several automated steps:
1. Table Renaming: Identifies tables prefixed with getcandy_ and migrates their data into corresponding lunar_ tables.
2. Polymorphic Relationship Updates: Updates polymorphic type columns (e.g., model_type, element_type, taggable_type) by replacing the string 'GetCandy' with 'Lunar'.
3. Attribute Data Migration: Updates the attribute_data column in products, product_variants, customers, and collections tables to replace 'GetCandy' with 'Lunar'.
4. Brand Migration: Specifically handles the migration of brand names from getcandy_products into the lunar_brands table and maps the resulting brand_id on products.
5. Migration Cleanup: Removes old migration records and runs standard migrations.
Note: Once the migration is finished, you can safely delete the old getcandy_ tables.
https://github.com/lunarphp/lunar/blob/1.x/packages/core/src/Console/Commands/MigrateGetCandy.php
Prune old shopping carts via lunar:prune:carts
1.x
Run the lunar:prune:carts command to clean up the carts table. This command removes old shopping carts and their associated lines and addresses. It uses a pipeline system that can be extended via configuration.
https://github.com/lunarphp/lunar/blob/1.x/packages/core/src/Console/Commands/PruneCarts.php
Index model data with lunar:search:index
1.x
Use the lunar:search:index command to index model data through Laravel Scout. By default, this command indexes all models defined in your lunar.search.models configuration. You can target specific models or use flags to manage how the index is updated.
https://github.com/lunarphp/lunar/blob/1.x/packages/core/src/Console/Commands/ScoutIndexerCommand.php