Local dev setup
This section describes how to run the project locally.
Prerequisites
Node.js
20+- Personal Access Token with the scope read:packages
Download Node.js from the official website and use nvm to switch to a compatible version.
Repository fork
We recommend working with a fork of the app repository. A fork allows you to easily incorporate updates from this boilerplate into your own codebase.
Authentication
PlentyONE system
- Add your API endpoint
- Add your API security token
Starting the app
- Open the repository in your command line interface.
- Run
npm install
to install all dependencies. - Run
npm run dev
to start the development server. The app will be served with hot reload at localhost:3000.
Custom configuration
By default, the app connects to a demo shop. The demo shop uses English as the default locale and German as a second locale. To connect to your own PlentyONE system, you have to update the API endpoint in the middleware and match the locale configuration in system and app.
For details, refer to the following guides: