0.1.0 • Published 9 years ago

sandfox-node v0.1.0

Weekly downloads
4
License
-
Repository
github
Last release
9 years ago

SandFox Node


Build Status License

NPM

What is SandFox Node?

SandFox Node framework with usefull utilities to manage use it in your projects.

Note: SandFox Node requires a minimum Node.js version of v0.12.0.

Getting Started

This plugin requires Grunt.

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install sandfox-node --save-dev

Usage

Now you can type in your command line terminal the syntax to compile the library

$ npm run compile

Check if dist/sandfox.css and dis/sandfox.css.map are created and have fun!

Documentation

Check out sandfox.com for guides and documentation.

Contributing

...

Folder Structure

src/ 
| 
|– base/ 
|   |
|   `– _base.scss
| 
|– components/
|   |
|   `– _components.scss
|
|– helpers/
|   |
|   |– variables/
|   |   |
|   |   `– _variables.scss
|   |
|   |– functions/
|   |   |
|   |   `– _functions.scss
|   |
|   |– mixins/
|   |   |
|   |   `– _mixins.scss
|   |
|   `– placeholders/
|       |
|       `– _placeholders.scss
| 
|– layout/
|   |
|   `– _layout.scss
| 
`– main.scss

License

The MIT License (MIT)

Copyright (c) 2015 SandFox

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.

Credits