search

stormpath / stormpath-flask

Build simple, secure web applications with Stormpath and Flask!
http://flask-stormpath.readthedocs.org/en/latest/
Other
155 stars 31 forks source link

Quickstart needs clarity #71

Open mdeggies opened 8 years ago

mdeggies commented 8 years ago

Being unfamiliar with Flask, we had to do a lot of googling to get the flask quickstart working.

The first step is to import flask:

from flask import Flask

We also had to define our app like this:

app = Flask(__name__)

This simple stuff should be covered in the quickstart.

Then...

To actually start the server, we had to do a few more things (that are also not covered in the docs): 

export FLASK_APP=file-name.py
flask run

In addition, as no home route was defined in the quickstart, we got a 404 when we navigated to localhost:5000.. that should just be covered in the quickstart too.

bertildaniel commented 8 years ago

@mdeggies Is it not expected you know what Flask is if you're going to use this Flask extension? Flask quickstart is at http://flask.pocoo.org (first paragraph) which covers everything you mentioned above.

secdec24 commented 7 years ago

The Stormpath website also has a Build a Flask App in 30 minutes which guides you through setting up a Flask app with Stormpath integration from scratch. I agree that the flask-stormpath quickstart should be about how to set up Stormpath with your Flask app and should therefore require/assume prior Flask knowledge.