slush-airframe

Slush Airframe

Airframe: A Project Starter Kit, made with love by Planetary

What does it do?

Airframe allows you to rapidly prototype sites by providing a lightweight scaffold. It makes suggestions without being too prescriptive.

The scaffold includes gulp for compilation, jade for templates, scss for smart CSS compilation, and browserify for Javascript compilation.

In addition to the compilation tasks, Airframe includes:

• A clear, concise default folder structure that is suggested but not prescribed.
• A small amount of default SCSS for normalization and to provide basic grid functionality.
• Two browserify transforms: bulkify which allow you to glob entire folders of client-side JS and brfs which allows you to use fs.readFile[Sync] from client-side JS.
• A default style guide (at /styles) that can be used as a jumping-off point for design.

Getting Started

Install slush-airframe globally:

$ npm install -g slush-airframe

Usage

Create a new folder for your project:

$ mkdir my-slush-airframe

Run the generator from within the new folder:

$ cd my-slush-airframe && slush airframe

Getting To Know Slush

Slush is a tool that uses Gulp for project scaffolding.

Slush does not contain anything "out of the box", except the ability to locate installed slush generators and to run them with liftoff.

To find out more about Slush, check out the documentation.

Contributing

See the CONTRIBUTING Guidelines

Support

If you have any problem or suggestion please open an issue here.

License

The MIT License

Copyright (c) 2015, Planetary Corporation

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.