magpie-base

magpie-base

Base components in Vue for _magpie-powered experiments.

Installation

First, ensure you have Node.js installed.

To install this package, run npm install -g magpie-base.

To initialize a new experiment based on magpie (after installing the package), run magpie new experiment-name.

For more information, please visit the project homepage

Documentation

The API reference for the latest version is available at magpie-reference.netlify.app.

Core Development

Development principles

• Components should not expose CSS classes for manipulation but instead offer customization either via unstyled slots or via props.
• Pre-packaged screens are more of a convenience should be rather easy to replicate with normal userland code

Linting

Before committing changes it is recommended to run the linter to make sure the changes adhere to the general coding style.

Run the js/vue linter using

npm run lint:fix

and the css linter using

npm run stylelint:fix

Docs

In order to spin up a local web server with the docs run npm run docs.

In order to build the docs run npm run docs:build.

The contents and organization of the docs are declared in styleguide.config.js. Each source folder should have a docs.md file with a general introduction to the feature in said folder.

The online docs are automatically built from the latest commit of the master branch.

Vue components

All Vue components must be exported in src/components/index.js in order to be available in downstream projects without importing them.