README.md

powered by

Alokai integration with PlentyONE

Welcome to the PlentyONE integration for Alokai.

Development setup

This section describes how to run the project locally with the preconfigured demo system.

Fork repository

We recommend working with a fork of this repository. A fork allows you to easily incorporate updates from this boilerplate into your own codebase.

1. Create a fork.
2. Clone the forked repository.

Create authentication token

This project queries data from PlentyONE by using other NPM packages as middleware. These packages are published on the GitHub registry. To download packages from GitHub's registry, you have to authenticate.

To enable authentication, create a Personal Access Token (PAT) with the scope read:packages.

Set up environment

Create an environment file under apps/web/.env. The minimum required configuration includes your PAT, the API endpoint of your PlentyONE system and the corresponding API security token:

# apps/web/.env

NPM_AUTH_TOKEN=
API_ENDPOINT=
API_SECURITY_TOKEN=

Download Node.js from the official website. We recommend using nvm to easily stay compatible with new versions. Then install all dependencies using Yarn.

# installs nvm (Node Version Manager)
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.0/install.sh | bash

# downloads and installs Node.js according to the project version in .nvmrc
nvm install

# downloads and installs Yarn according to the project version, and downloads, installs, and builds all dependencies
npm run setup:unix

Start the app

Run yarn dev to start the development server. The app will be served with hot reload at localhost:3000.

Resources

Documentation

• Developers Documentation
• Technical Overview

Changelog

English | German

Features

• Turborepo remote cache build system, with blazingly fast execution of commands (build, lint, test etc.) on your local machine.
• TypeScript support.
• Nuxt.js 3 & Server Side Rendering for great UX, loading and SEO scores.
• Beautiful components built with TailwindCSS and Storefront UI - a lightweight, accessible, and customizable component library built for e-commerce.
• Unit tests with Vitest and Vue Test Utils.
• ESLint for code linting.
• Prettier code formatter.
• Husky for working with Git hooks efficiently.
• Conventional Commits standard for commit messages.
• Staged code linting with lint-staged.
• Progressive Web App features with Vite PWA for Nuxt.
• i18n localisation powered by Nuxt-i18n.
• Alokai SDK ready - integrate headless E-commerce platform with your project easily.
• Alokai Middleware.
• Maximized lighthouse score.

Alokai

• Introduction to learn what is Alokai.
• Alokai Documentation
• Storefront UI Documentation
• Community Chat

License

Distributed under the MIT License. See LICENSE for more information.

Contributing

Please see our CONTRIBUTING.md for more information.

Support

If you have any questions about this integration we will be happy to answer them on the plentymarkets channel of the Alokai Discord.