phi: A Web-App (and Website) Toolkit and Modular Framework

Do not use this! It is still in rapid development and in a pre-release stage.

Status: Version 0.16 — Currently: missing core app features; in cross-browser and cross-device testing.

The goal of this project is to create a web application toolkit and framework that is completely open with the fewest of dependencies, built with the best in modern technology and incorporates the modular (component) approach to development. This is also a very opinionated stack that focuses on integration, rather than a mash-up of disparate technologies. Make sure you like my tech-stack before diving in ;)

What Will Version 1.0 of phi Include?

App Features (ALMOST DONE):

Core Services

1. AngularJS Intergration (DONE)
2. CRUD API (IN PROGRESS)
3. Data JS object manipulation API (IN PROGRESS)

Components (Directives)

1. Click-event delegation (DONE)
2. Date validation & format automation (DONE)
3. Phone number validation & format automation (DONE)
4. Time validation & format automation (ALMOST DONE)
5. Basic alert functioning & management (DONE)

UI & Ix Features (DONE):

Core Features

Built-in, default features

1. Compass & Sass Driven (DONE)
2. CSS Normalization (DONE)
3. Grid system with two types (DONE)
   • inline-block type
   • table-cell (seamless) type
4. Typographic ruleset (DONE)
5. Button styling and features (DONE)
   • Primary, secondary and tertiary styles
   • Group and button bar features
6. Navigational styling and features (DONE)
   • Horizontal style
   • Vertical style
   • Optional drop-down menu features
   • Tab UI and IxD
7. Basic form styling and features (DONE)
8. Basic media queries (DONE)
9. Prototype layer for rapid prototyping (IN PROGRESS)

Extensions

These are 'pluggable' modules/components

1. Tabbed UI (DONE)
2. Helper Classes (DONE)
   • Breadcrumbs
   • Labels
   • Panels
   • Progress Bars
   • Img Thumbnails
   • Inline Lists
   • Flexible Videos
3. Modals with multiple, desktop sizes (DONE)
4. Wayfinding navigation (section aware) (DONE)
5. Alerts (DONE)
6. Date Picker (DONE)

Misc. Tasks left before 1.0 release

1. Complete and integrate object manipulation API into demo. (IN PROGRESS)
2. Provide client-side routing demo. (NOT STARTED)
3. Separate prototyping layer from core framework. (IN PROGRESS)

What Are Planned Features (version 1.5)

App Features That Extend AngularJS:

Components (Directives)

1. System wide, advanced alert & notification system
2. Angular integrated modal + content viewer (e.g. go to next or prev within modal)
3. Custom multi-select integration
4. Advanced multi-group toolbar integration

UI & Ix Features:

Extensions

1. More advanced responsiveness with JS and media queries
2. Integrate scrolling animation to Wayfinder nav.
3. Click driven popovers and tooltips
4. Content carousel
5. Image gallery/viewer
6. Accordion
7. Toolbar UI
8. Improve responsiveness for mobile
   • Responsive tables
   • Make vertical tabs more mobile friendly version
   • Make Wayfinder more mobile friendly version
   • Collapsible Navigation

JS that passes tests

1. Not started

Suggested Features

1. Event Driven Notifications by User / Re-Useable Errors and Alerts (This will be a WIP for a bit)
   • Must not be removed on close
   • Custom notifications per page
   • I would like to see it as a JS array
   • Instantiated on the Layout Page
2. Form validations (AngularJS handles validation natively)
   • Validations that cross boundaries between PHP and Javascript
   • Errors and notifications that are the same on both sides

Dependencies

1. Compass Ruby Gem
2. Node.js
3. Grunt.js
4. Assorted Grunt Plugins

Below is a list of the integrated technologies:

• UI & Ix Framework based off of Zurb's Foundation
• HTML5 Boilerplate
• AngularJS seed
• jQuery with differing build versions
• Lo-Dash: A JS utility library
• Modernizr
• Waypoints Plugin
• Node.js & Grunt
• Compass and Sass
• Testacular & Jasmine
• Grunt.js and assorted plugins

I'd like to thank all the teams responsible for the above listed technologies and their generous open-source philosophies. Because of these great people and their openness to sharing, we are allowed to stand on the shoulders of those that come before us. Thank you.

The MIT License (MIT)

Copyright (c) 2013 Justin Lowery

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.