# Foundation Ultimate
------------------
The Ultimate Foundation Package with both FoundationApps and Foundation Sites Included
Whats it all about ? Please see our [trello board](https://trello.com/b/szKL28MY) to see what were upto
----------------------
**Release** : n/a - Please See Development Branch untill released
**Status** : First Public Draft - Everything subject to change
----------------------
[](https://travis-ci.org/Relution-Developments/Foundation-Ultimate)
**TravisCI:** *Continuous Integration*
[](https://gemnasium.com/Relution-Developments/Foundation-Ultimate)
**Gemnasium:** *Gemnasium checks the project's dependencies and when they need to be updated.*
[](https://www.codacy.com/app/jay-demitri/Foundation-Ultimate)
**Codacy:** *Code Analysis to ship Better Code, Faster.*
[](https://app.wercker.com/project/bykey/b01bef8c16557ea1bc61206ad6fc6452)
**WerckerCI:** *Continuous Integration*
[](https://codeship.com/projects/138369)
**CodeShipCI:** *Continuous Integration*
----------------------
## Contents
- [About](#about)
- [Demo](#demo)
- [Features](#features)
- [Requirements](#requirements)
- [Installation](#install)
- [CLI Usage](#use)
- [License](#License)
----------------------
#### About
----------------------
Foundation for sites and foundation for apps are both great frameworks.
Having to choose between components or being restricted to only being able to use angular with foundation for apps well
that just sucks.
So I present to you foundation-ultimate.
With inspiration from angular-foundation plus the want/need for foundation sites components in my angular projects I have
decided to take on the project to combine both foundationApps and foundationSites I wont be combining everything and it wont
be all at once the first one on my list is the grid and from there on out if there is anything in particular you would want
please make a request through github.
Alot of this documentation is still in the todo stage and so is very much subject to change. Documentation for the components
will be added as I add them and included as the demo of this repo :)
----------------------
#### Demo
----------------------
Working On It
The demo will be our documentation hosted on gh-pages themed and built to update from our code
Please bare with me
----------------------
#### Features
----------------------
- Built in CLI that can be used globally or locall for managing our project its dependencies
and our build from src to dev to release.
----------------------
#### Requirements
----------------------
- NodeJs | Installed from their website
- Git | Windows users checkout rails installer or github for windows
----------------------
#### Installation
----------------------
##### Local Installation
Will Update Once Confirmed may have the final build command destroy the build code after storage.
Still linking gulp to cli and vice versa.
```bash
// Clone The Repo
C:\User> git clone https://github.com/Relution-Developments/Foundation-Ultimate.git
// Change to your newly created project
C:\User> cd foundation-ultimate
// Install nodeJs package deps
C:\User\foundation-ultimate> npm install
// Build & Preview
C:\User\foundation-ultimate> gulp preview
// Or - This will be similar for global cli use
C:\User\foundation-ultimate> npm run foundationUltimate preview
```
##### Global Installation
Global installation is already available via node package manager (npm)
Although the global cli has no actual purpose yet install using the following command:
```bash
// Install foundation-ultimate globally (Hence the -g)
C:\User> npm install -g foundation-ultimate
// Now open a terminal in any location and use
C:\User> foundationUltimate
// Help will be displayed.....
--------------------------------------------------------------
F O U N D A T I O N U L T I M A T E
-------------------------------------
BluJay - Relution Developments
--------------------------------------------------------------
```
----------------------
#### License
----------------------
Foundation Remix is released under the MIT License
The MIT License (MIT)
Copyright (c) 2016 Relution Developments Ltd
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.