Giter Club home page Giter Club logo

cookiecutter-flask's Introduction

cookiecutter-flask (plus some stuff)

A(nother) Flask template for cookiecutter.

cookiecutter

Modified from the version authored by Github user: sloria

Goals

The primary goal is to have a different logical split of files (models, views and services instead of public, user, etc), which is purely personal preference.

Secondary is a slight expansion in scope to include other common pages and functionality, which is in progress. So far we have completed:

  • Forgotten password handling
  • Username change
  • Password change
  • Unsubscribe
  • Google Analytics Integration
  • Heroku Integration

In progress are:

  • Simple text and external image blog powered by markdown

For the future are:

  • Sample contact form and page
  • Basic Admin UI
  • Example T&Cs
  • Social Links/Integration
  • Login outside of the header (maybe modal)
  • Commenting on blog via discus or similar
  • Etc.

A live example can be found here: CookieCutter Flask Demo

Contributing

If you are interested in contributing please let me know, any of the future goals listed above would be great to help with.

Use it now

$ pip install cookiecutter
$ cookiecutter https://github.com/wdm0006/cookiecutter-flask.git

You will be asked about your basic info (name, project name, app name, etc.). This info will be used in your new project.

Full example for pushing app to Heroku here <http://willmcginnis.com/2015/09/28/cookiecutter-flask-and-some-other-stuff/>_

screenshot

Features

  • Bootstrap 3 and Font Awesome 4 with starter templates
  • 3 Bootstrap themes included (standard, dark, and paper)
  • Flask-SQLAlchemy with basic User model
  • Easy database migrations with Flask-Migrate
  • Flask-WTForms with login and registration forms
  • Flask-Mail for forgotten password emails
  • Username/Password reset and unsubscribe functionality baked in
  • Flask-Login for authentication
  • Flask-Bcrypt for password hashing
  • Out-of-the-box ready for deploying to a PaaS (e.g. Heroku)
  • pytest and Factory-Boy for testing (example tests included)
  • A simple manage.py script.
  • CSS and JS minification using Flask-Assets
  • Caching using Flask-Cache
  • Useful debug toolbar
  • sitemap.xml and robots.txt built in
  • Utilizes best practices: Blueprints and Application Factory patterns

Inspiration

License

BSD licensed.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.