fultra v0.6.0
Fultra
Fultra is an angular-powered framework for building powerful responsive web based applications. Combining the best of foundation for apps and sites the aim of fultra is to provide a set of tools that can be used to build modern, fast and responsive web applications.
Fultra is planned to have alot of features that foundation did not already have like built in compatibility with node-webkit and angular powered alternative to orbit and more.
Release Infomation
Release: n/a
Documentation Status: FIRST DRAFT - Everything is subject to change
Build Infomation & Status:
Contents
- Demo
- Features
- Requirements
- Getting Started
- Docs
- Directory Structure
- Support / Contributing
- Versioning
- Release History
- License
Demo
Will Update Later
Features
- Foundation-Apps (Currently v1.2.0)
- The Grid
- Panels
- Action Sheets
- Menu Bars
- Off Canvas
- Title Bar
- Modal
- Notification
- Buttons
- Forms
- Accordion
- Block List
- Cards
- Interchange
- Labels & Badges
- PopUp
- Tabs
- Typography
- Iconic
- Utilities
- Functions & Mixins
- Font-Awesome
- Gulp Cli - Complete build tasks using the latest version of gulp v4.0alpha See Here
- Babel - Javascript written in the latest es2015 syntax (is this the correct way of saying it)
Will Update Later
Requirements
- NodeJs | Install using thier installer provided on the NodeJs website
- Git | Use the installer provided for your OS, Windows users have a look at RailsInstaller or Github for Windows
- Ruby | Use the installer provided for your OS, Windows users once again have a look at RailsInstaller or JRuby
- With Ruby installed open a command prompt and use the following command
gem install sass
- Gulp and Bower | Open a command prompt with NodeJs & Npm Installed
- Type
[sudo] npm install -g gulp bower
Getting Started
Installation
The Sass and Js components are available directly on bower, composer and npm using one of the following:
// As an npm package
npm install --save fultra
// As a bower component
bower install --save fultra
// Or with composer
composer require fultra
Building This Repo & The Docs
If you want to work with the the source code directly or compile the documentation for local use follow these steps
git clone https://github.com/JayDemitri/Fultra.git
cd fultra
npm install
bower install
// Then for a list of commands type 'gulp' or
gulp launch:docs
Documentation
For the moment any documentation we have will be contained as an application within the repo that can be compiled using the above.
Alternatively any documentation will be kept on our wiki page and added on an ad-hoc basis.
Current Documentation On Wiki
Directory Structure
Currently We are using the following structure:
- /ROOT/ - bin/ | Our NodeJs files are kept in ere - build/ | Our Application in most cases the docs are built here - dist/ | Fultras Distibutable files are here - docs/ | Fultras Documentation App (Raw) - fonts/ | Any Font Here - img/ | Images - js/ | Any Javascript from angular to jquery plugins go here - node_modules/ | Node modules are kept here when you install - scss/ | Scss Libs - vendor/ | Bower Dependencies - tests/ | Any Tests - Coming Soon
Support / Contributing
We are still working this part out as we are working trello into our development workflow.
Will Update Later.
Versioning
Just like Foundation, Fultra follows semver and will apply from v1.0.0. so braking changes will not be introduced in minor or patch versions.
Unlike foundation we work our repo branches a little differently.
Our master
branch will always contain stable production ready code.
Our beta
branch is were our latest features are released for users to play with and thus although should be stable is not production ready.
Our development
branch speak for itself.
Release History
We are currently working towards v1.0.0 on the master branch of this repo release history upto this point is tracked through our trello boards and commits, sorry.
License
Fultra is release under the MIT License a compy of which is included in the root of the project. Please Note that since fultra is backboned from Zurbs Foundation Sites/Apps All License's Belonging to them remain inplace.
The MIT License (MIT)
Copyright (c) 2016 Jay Demitri | London Development Studio
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.