jfeinstein10 / generator-afs

Yeoman generator for an Angular-Flask-SQLAlchemy web app.

generator-afs

a Yeoman Angular-Flask-SQLAlchemy generator

Setting Up

Make sure you have the following installed:

• node, npm (usually comes with node), bower (npm install -g bower), and yeoman (npm install -g yo)
• python (for OS X or Windows), pip, and virtualenv

To install generator-afs, run:

$ git clone https://github.com/jfeinstein10/generator-afs.git
$ cd generator-afs
$ npm link

Creating an App

$ yo afs

You'll see the following prompts with the following options:

• What would you like to name your project?
• Please supply a secret key for the app
• What database URL would you like the server to connect to?
• Which (if any) CSS pre-processor would you like to use? (None, less, scss, or sass)
• Which (if any) CSS Framework would you like to use? (None, Bootstrap, Foundation, Angular Material)

After creating an app run the following commands in the same directory:

$ virtualenv venv                               # This creates a virtual environment so we can isolate the requirements of this app from the rest of your computer
$ source venv/bin/activate                      # This activates the virtual environment (or venv\Scripts\activate for Windows users)
$ pip install -r requirements.txt               # This installs the app's Python dependencies within the virtual environment
$ migrate create models/migrate <your app name> # This sets up database versioning (check out the sqlalchemy migration docs)

And you can finally run the app with

$ source venv/bin/activate      # Remember to stick to your virutal environment!
$ python serve.py               # And finally this starts the server

Some useful things to know about your new app

• You can edit your app configuration (debug mode, database URL, etc.) in settings.cfg
• You can manage your database and migrations via sqlalchemy-migrate with python manage.py
• To add a dependency via bower, you also have to add it to static/bundles.yaml so that it gets loaded in the browser

Scaffold All the Things!

Then you can scaffold other parts of your app with the following subgenerators!

Creating new Flask Endpoints

$ yo afs:endpoints

You'll see the following prompts with the following options:

• What would you like to name your controller?
• What URL would you like this endpoint to have? (e.g. /api/search/<search_term>)
• What methods would you like this endpoint to accept? (GET, POST, PUT, and DELETE)
• What would you like to name the Python function for this endpoint?
• Would you like to define another endpoint for this controller? (y/N)

Creating a new Angular page (a new collection of Angular components)

$ yo afs:page

You'll see the following prompts with the following options:

• What would you like to name the page?

Creating a new Angular component (controller, directive, or service)

$ yo afs:component

You'll see the following prompts with the following options:

• What type of component would you like to create? (controller, directive, or service)
• What would you like the to name the [controller]?
• Would you like to create a new route for this controller? (y/N) (only for controllers)
• What would you like that route to be? (e.g. /search/:search_term) (only for controllers)
• What page would you like the [controller] to belong to?