smithery

This is the functional package for the smithery framework. It implements the core functionality to support the feature oriented programming approach. Additionally it provides some additional parts to setup for a full project, which uses the feature oriented programming approach.

Intended usage

smithery's intended usage is as a project dependency. If you want to use it as a command line tool, install smithery-cli instead.

Installing

For the latest release:

  npm install smithery

Documentation

There is currently no explicit documentation available. We are sry for this, it is expected to come soon.

Contributing

There are several ways to contribute:

• submit bugs

• contribute bugfixes

• submit new features with pull-requests

• propose new features within the issue tracker

Building

smithery is fully implemented with typescript, therefore to build you need GIT and NodeJS installed.

Clone a copy of the repo:

git clone https://github.com/tabris87/smithery.git

Change to the smithery-core directory:

cd smithery/smithery-core

Install the dependencies:

npm install

Run the build:

npm run build