dystcz/lunar-api

Lunar API

0.8.10 2024-04-18 09:18 UTC

Requires

• php: ^8.2
• illuminate/support: ^10.0
• laravel-json-api/hashids: ^2.0
• laravel-json-api/laravel: ^3.4
• laravel-json-api/non-eloquent: ^3.0
• lunarphp/lunar: ^0.8

Requires (Dev)

• barryvdh/laravel-ide-helper: ^2.13
• driftingly/rector-laravel: ^0.17.0
• laravel-json-api/testing: ^2.1
• laravel/pint: ^1.7
• orchestra/testbench: ^8.0
• pestphp/pest: ^2.0
• pestphp/pest-plugin-laravel: ^2.0
• rector/rector: ^0.15.23
• spatie/laravel-ray: ^1.32

MIT

• Jakub Theimer
• Marek Lőrincz

• php
• laravel
• lunar
• dystcz
• lunar-api

README

What's going on here?

This package introduces an API layer for the Lunar ecommerce package. It connects the Lunar backend with your SPA, other applications, and possibly with a mobile app.

The main aim is to provide a solid foundation for your e-commerce project, giving you a head start while maintaining flexibility so you can easily build features to meet your project's needs.

Some perks

• Focus on extensibility
• Wannabe ecosystem of complementary packages with emphasis on the plug and play spirit
• Already running in production 🤫
• Built on top of Laravel JSON:API

Feature set

• Configurable checkout flow with guest checkout
• Solid extensibility (Models, Schemas, Resources, Routes, ...)
• Payment adapters registrar (currently Stripe & Mollie)

Work in progress 🚧

• Documentation Wiki
• Vitepress documentation
• Better test coverage
• Paypal payment adapter
• Custom model filters
• Composable products (good for configurators)
• Purchasable payment options
• HashIds

Planned 🕛

• Automated Open API documentation
• Authentication flow (currently has to be implemented in the main app)
• More streamlined configuration

Feature requests and ideas 💡

Got an idea? Share it in a dicussion or create an issue.

Getting started guide

Requirements

• PHP ^8.2
• Laravel 10
• Lunar requirements

Installation

You can install the package via composer

composer require dystcz/lunar-api

Publish config files

You will probably need them pretty bad

php artisan vendor:publish --provider="Dystcz\LunarApi\LunarApiServiceProvider" --tag="lunar-api"

Publish migrations

Only in case you want to customize the database schema

php artisan vendor:publish --provider="Dystcz\LunarApi\LunarApiServiceProvider" --tag="lunar-api.migrations"

Let's hit your first endpoint

Just visit /api/v1/products and you should see a list of products.

Hopefully everything went smooth so far. If not, please create an issue.

You can view the rest of the API routes by running php artisan route:list --name=v1 in your terminal.

Useful resource

• Postman request collection [🚧] , so you can test the API with ease
• Laravel JSON:API Docs , if you plan to extend the API

Testing

composer test

Lunar API compatible packages

• Reviews (Adds user reviews functionality)
• Product Views (Store unique product views in Redis)
• Product Stock Notifications (Notify users when product is in stock again)
• Newsletter (Newsletter sign up with support for Mailchimp / Mailcoach / Brevo)
• Stripe Payment Adapter
• Mollie Payment Adapter
• PayPal Adapter [🚧]

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• All Contributors
• Lunar for providing awesome e-commerce package
• Laravel JSON:API which is a brilliant JSON:API layer for Laravel applications

License

The MIT License (MIT). Please see License File for more information.