generator-susy-flask

Yeoman generator for Flask & Susy project

Getting Started

What is Yeoman?

Not every new computer comes with a Yeoman pre-installed. He lives in the npm package repository. You only have to ask for him once, then he packs up and moves into your hard drive. Make sure you clean up, he likes new and shiny things.

npm install -g yo

Yeoman Generators

Yeoman travels light. He didn't pack any generators when he moved in. You can think of a generator like a plug-in. You get to choose what type of application you wish to create, such as a Backbone application or even a Chrome extension.

To install generator-susy-flask from npm, run:

npm install -g generator-susy-flask

Now that the generator is installed, create a directory for your new project

mkdir my-yo-project
$ cd my-yo-project

and then run:

yo susy-flask

Run your project

After the project initialized, we need:

Run gulp tasks:

$ cd {your-app-name}
$ gulp

And remember to install python packages (install in virtualenv):

$ cd my-yo-project
$ virtualenv env
$ . env/bin/activate
$ pip install -r {your-app-name}/pip-requires.txt
$ python run.py

Finally your website will run at http://localhost:8888/.

Packages Used

• Flask
• Susy 2
• Gulp.js
• webpack
• node-sass

License

MIT