Skip to content

Latest commit

 

History

History
102 lines (67 loc) · 5.61 KB

README.md

File metadata and controls

102 lines (67 loc) · 5.61 KB
Alokai

plentysystems logo

Alokai Integration With plentysystems

GitHub Repo stars X Follow YouTube Channel Subscribers Discord

Welcome to the plentysystems integration for Alokai.

Development setup

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

Prerequisites

Download Node.js from the official website or use nvm to switch to a compatible version. For installation instructions for Yarn, refer to the Yarn documentation.

Repository fork

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.

Authentication

This project queries data from plentysystems 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, carry out the following steps:

  1. In the root directory, create a new file called .yarnrc.yml.
  2. Copy the contents of .yarnrc.yml.example to .yarnrc.yml.
  3. In .yarnrc.yml, replace <TOKEN> with the Personal Access Token you created earlier.

Git doesn't track .yarnrc.yml, so you don't have to worry about exposing your token.

Setup environment

  1. Add your API endpoint
  2. Add your API security token

Starting the app

  1. Open the repository in your command line interface.
  2. Run yarn to install all dependencies.
  3. Run yarn dev to start the development server. The app will be served with hot reload at localhost:3000.

Resources

Documentation

Changelog

EnglishGerman

Features

Alokai

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.