Giter VIP home page Giter VIP logo

hapi-pattern-library's Introduction

Hapi-Pattern-Library

A Pattern Library based on Hapi.js

This Pattern Library also acts as a task manager. When a change is made to a Component, Pattern, or Template the app scripts and styles will be recompiled and the browser updated.

Getting started

You will need to have a recent version of node installed

If node is installed run the following commands to get started:

    $ npm install
    $ npm start

Usage

Pattern Library

The pattern library consists of Components, Templates, and Patterns.

In order to add more of each simple follow the same structure as shown by the examples.

Generators

Firstly cd into project root.

  • Add new Component: bash ./sh/component.sh <component-name>
  • Add new Template: bash ./sh/template.sh <template-name>
  • Add new Pattern: bash ./sh/pattern.sh <pattern-name>

NB: Once a component is added you will need to manually include its scripts and styles.

  • Add component styles to: ./pattern-library/assets/styles/main.scss
  • Add component scripts to: ./pattern-library/assets/scripts/main.js

Feature List

TODOS

  • Style frontend
  • Add export function
  • Add search functionality

Added

  • Display list of components
  • Compile and minify Pattern Library scripts/styles
  • Display app info in api
  • Re-render component on file change
  • Display Component's Markup, Context, Styles, Scripts, and Docs
  • Expose JSON Api
  • Seperate folder structure
  • Add watch functions
  • Implement React JS serverside rendering
  • Add generators for Components, Templates, and Patterns

hapi-pattern-library's People

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.