open-index/open-npm huggingface dataset:
npm package: @plentymarkets/shop-core
Description: Core module for PlentyONE Shop
Latest version: 1.23.2

# Shop Core

Core nuxt module for PlentyONE shops enabling essential functionalities and integrations.

- [📚 &nbsp;Documentation](https://pwa-docs.plentyone.com/guide/modules/shop-core/)

## Quick Setup

Install the module to your Nuxt application with one command:

```bash
npx nuxi module add @plentymarkets/shop-core
```

## Contribution

To use the playground for developement and testing, follow these steps:

- Rename `.env.example` to `.env` and set your API security token:
  `API_SECURITY_TOKEN="your-token-here"`
- Adjust `playground/nuxt.config.ts` if needed.

```bash
# Install dependencies
npm install

# Build the module and prepare
npm run go

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint:fix

# Run Prettier
npm run format:fix

# Run Vitest unit tests
npm run test
npm run test:watch

# Install Playwright browsers
npx playwright install

# Run playwright E2E tests
npm run test:e2e
npm run test:e2e:dev
```

<!-- Badges -->

[npm-version-src]: https://img.shields.io/npm/v/shop-core/latest.svg?style=flat&colorA=020420&colorB=00DC82
[npm-version-href]: https://npmjs.com/package/shop-core
[npm-downloads-src]: https://img.shields.io/npm/dm/shop-core.svg?style=flat&colorA=020420&colorB=00DC82
[npm-downloads-href]: https://npm.chart.dev/shop-core
[license-src]: https://img.shields.io/npm/l/shop-core.svg?style=flat&colorA=020420&colorB=00DC82
[license-href]: https://npmjs.com/package/shop-core
[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js
[nuxt-href]: https://nuxt.com