1.5.3 • Published 5 years ago

@puzzleframework/lite v1.5.3

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

Puzzle Framework Lite

Puzzle Framework Lite wants to be a simple to use framework to build webapps using a micro-application architecture.

The purpose of this framework is to be as small and lite as possible. It is composed of core elements and some core modules (called puzzles). The core modules can be enable/disabled through feature switches in the application that uses the framework.

Build Status

  • Master: Build Status Coverage Status

  • Develop: Build Status Coverage Status

  • Release: Build Status Coverage Status

  • Hotfix: Build Status Coverage Status

Sample project

The sample project where different functionalities are shown is available here: https://github.com/spark-development/puzzle-framework-lite-sample

Anyone can download that project and build upon it.

Contributing

To contribute please read the CONTRIBUTING.md file.

Documentation

The documentation of the framework is split into 2 major folders:

  • docs - where all the developer written documentation is
  • gen-docs - where the generated documentation is

The docs is structured by the different modules that are available in the application.

The gen-docs contains code documentation generated by jsdoc. To generate a new version of this documentation please use the npm run jsdoc command. Documentation generated under this folder SHOULD NOT be committed. They will be updated by a repository maintainer.