spiral/toolkit

Set of virtual tags and frontend library

Spiral Toolkit

AJAX and form serialization toolkit for Spiral Framework., _(*1)

Repository consists of 2 main components: Toolkit and Keeper, _(*2)

Toolkit is set of modules implementing a simple front-end framework, capable of serializing forms, showing loaders and datagrids, _(*3)

Keeper is set of scripts that demonstrate typical toolkit usage with Spiral Frameworks, including default styles based on bootstrap 4., _(*4)

Prerequisites

• node 11.15.0+ use recent LTS version
• yarn 1.17.0+ use recent stable version

Project is based on Lerna., _(*5)

Starting Up

1. Execute npx lerna bootstrap to install dependencies and link packages
2. Build toolkit package and dependencies yarn build

Additional development commands

When developing both in co-dependent packages use separate commands like so: - yarn build:core to build core package. - yarn build:form to build form package. - yarn build:lock to build lock package. - yarn build:toolkit to build toolkit package. - yarn build:datagrid to build datagrid package. - yarn build:keeper to build keeper package., _(*6)

Alternatively execute yarn build from package folder., _(*7)

Additional commands

npx lerna run lint to lint every package. Note this command is expected to be successfully completed before pushing data to repository., _(*8)

Project structure

Project is a mono-repository with following packages: - packages/core - core of the toolkit - packages/form - form module for the toolkit - packages/lock - lock module for the toolkit - packages/core - main toolkit package, _(*9)

Making a release

In separate branch do following:, _(*10)

• lerna publish
• bump version in lerna and in root package.json manually
• yarn gitrelease

Windows

On windows execute git config core.autocrlf false to disable automatic line ending conversion., _(*11)

MIT License (MIT). Please see LICENSE for more information. Maintained by Spiral Scout., _(*12)