millenniumjs

millennium.JS

Render your Front-End in less than 12 parsecs.

What is?

A javascript library for create Functional Stateless Components and render with Virtual DOM. Ideal for creating ultra light and fast applications with Redux.

Best Features

• Functional Components.
• Custom Props for manage unidirectional data flow.
• Virtual DOM Render.
• Easy selection real DOM nodes with global Refs.
• Compatible with JSX.
• Easy integration with Redux.

How to use?

Install

Tip: Verify if you have node and npm installed.

$ npm install millenniumjs --save-dev

Setup

ES6/ECMAScript 2015 module:

Tip: Use Webpack (or similar module bundler) to manage the components.

import millennium from 'millenniumjs';

CommonJS module:

Tip: Use Browserify (or similar module bundler) to manage the components.

const millennium = require('millenniumjs');

Make stateless components

import millennium from 'millenniumjs';

function Hello() {

  return (
    millennium.component(
      'h1',
      {className: 'foo'},
      'Hello World'
    )
  )

}

Tip: Use JSX to write your component declaratively.

import millennium from 'millenniumjs';

function Hello() {

  return (
    <h1 className="foo">
      Hello World
    </h1>
  )

}

Render with Virtual DOM

import millennium from 'millenniumjs';

function Hello() {
  // Markup
}

millennium.render(<Hello />, document.getElementById('root'));

Docs

Did you like it?
See complete documentation and start now with millennium.JS.

---

Development

Getting started

Clone this repository and install its dependencies:

$ git clone https://github.com/millenniumjs/millenniumjs.git
$ cd millenniumjs
$ npm install

Build

Builds the library to dist:

$ npm run build

Builds the library, then keeps rebuilding it whenever the source files change using rollup-watch:

$ npm run dev

Code Style

Follow the JS Code Style Guide by Afonso Pacifer.

All code style are automatic validate with ESLint:

$ npm run lint

Code Docs

Generate code docs with JSDocs

$ npm run jsdocs

View code docs in out/index.html

Tests

Run all unit tests:

$ npm test

---

Versioning

To keep better organization of releases we follow the Semantic Versioning 2.0.0 guidelines.

Contributing

Want to contribute? Follow these recommendations.

History

See Releases for detailed changelog.

License

MIT License © Afonso Pacifer