An open API service indexing awesome lists of open source software.

https://github.com/dystcz/dystore-api

[READ ONLY] API layer for Lunar headless e-commerce package based on JSON:API
https://github.com/dystcz/dystore-api

api dystore json-api laravel lunar

Last synced: 17 days ago
JSON representation

[READ ONLY] API layer for Lunar headless e-commerce package based on JSON:API

Awesome Lists containing this project

README

        

# Dystore API

[![Latest Version on Packagist](https://img.shields.io/packagist/v/dystcz/dystore-api.svg?style=flat-square)](https://packagist.org/packages/dystcz/dystore-api)
[![Total Downloads](https://img.shields.io/packagist/dt/dystcz/dystore-api.svg?style=flat-square)](https://packagist.org/packages/dystcz/dystore-api)
[![Tests](https://github.com/dystcz/dystore/actions/workflows/tests.yaml/badge.svg)](https://github.com/dystcz/dystore/actions/workflows/tests.yaml)

> [!IMPORTANT]
> To open issues or contribute, please navigate to the [main repository](https://github.com/dystcz/dystore). This is a subtree split of [dystore](https://github.com/dystcz/dystore) monorepo.

> [!CAUTION]
> This package is currently under heavy development. It is already used in production, however, you should proceed with caution.

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.

## Requirements

- PHP ^8.2
- Laravel ^11|^12
- [Lunar requirements](https://docs.lunarphp.io/core/installation.html#server-requirements)

## Documentation

- Coming soon

### Testing

```bash
composer test
```

### Changelog

Please see [CHANGELOG](https://github.com/dystcz/dystore/blob/1.0/CHANGELOG.md) for more information what has changed recently.

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

### Security

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

## Credits

- [All Contributors](../../contributors)
- [Lunar](https://github.com/lunarphp/lunar) for providing awesome e-commerce package
- [Laravel JSON:API](https://github.com/laravel-json-api/laravel)
which is a brilliant JSON:API layer for Laravel applications

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.