slush-squarespace/README.md

A slush generator for working in an external environment on the Squarespace consumer platform

slush-squarespace
==============

> A [slush](http://slushjs.github.io) generator for working on the Squarespace consumer platform using an external environment.

## Installation

Remember to install `slush` globally as well, if you haven't already:

```bash
npm install -g slush
```

Install `slush-squarespace` globally:

```bash
npm install -g slush-squarespace
```

You'll also need to have bower installed for a smooth installation
```bash
npm install -g bower
```

## Usage

Create a new folder for your project:

```bash
mkdir my-squarespace-site
```

Run the generator from within the new folder:

```bash
cd my-squarespace-site

slush squarespace
```

You will now be prompted to give your new Squarespace project a name, which will be dasherized and used in its `bower.json` and `package.json` respectively.

### CSS Preprocessor

This scaffold uses Scss as the pre-procssor. For a different processor please contact me.

### Project structure

You will also have the option to generate a simple Todo list app in your project as well, to be used as a live example of how to structure your app.

The project structure with the Todo list example included will look like this:

```
my-angular-app/
├── bower.json
├── gulpfile.js                             # See "Gulpfile" below
├── package.json
└── src
    ├── js
    │   └── app.js                          # Main JS file
    └── scss
        ├── app.scss                        # Main router for Sass
        ├── components                      # Specific styles
        │   └── _manifest.scss              # Folder router for Sass
        └── core                            # Main styles
            ├── _main.scss                  # Non-component styles
            ├── _manifest.scss              # Folder router for Sass
            ├── _mixins.scss                # Global mixin declarations
            └── _variables.scss             # Global color and image declarations
```

### Gulpfile

This file sets up the build process and if you enable Auto SFTP, it will deploy your minified JS and CSS. Once you save, you have a `./dist` folder with all your scripts and stylesheets concatenated and minified.

## Changelog

See [releases](https://github.com/slushjs/slush-squarespace/releases).

## License

MIT