API and module host for nail build enviroments.
JavaScript CoffeeScript
Switch branches/tags
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
coverage
docs
lib
spec
src
test
.gitignore
.npmignore
Gruntfile.coffee
LICENSE-MIT
README.md
about.md
build.json
package.json

README.md

About

The nail-core serves as a module host for nail build enviroments.

Features

  • create classes from structured objects
  • create custom builders with modules
  • relevant meta data is added to all constructors
  • optional [namespace][About.namespaces] support
  • lean API

Usage

To create a new build enviroment use NailApi.use:

myNail = require('nail-core').use myModule, myOtherModule

It is recomended to define your nail builder in a seperate file and load it with require:

module.exports = require(nail-core).use myModule, myOtherModule

Once you have created a nail builder you can create new classes with the "NailApi.to" function.

myNail.to "myNamespace",
  MyClass:
    properties:
      name: 'anon'
    methods:
      hello: ()-> "hello #{@name}"

For a quick start use the nail bundle.

It already contains some modules and illustartes how to use nail builders to create new classes.

##Setup Install with npm:

npm install nail-core

Clone with GIT:

git clone git://github.com/noptic/nail-core.git

##Documentation Head here → docs

##Dependencies

##DevDependencies