stormpath-flask icon indicating copy to clipboard operation
stormpath-flask copied to clipboard

Quickstart needs clarity

Open mdeggies opened this issue 9 years ago • 2 comments

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.

mdeggies avatar Aug 09 '16 00:08 mdeggies

@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.

bertildaniel avatar Sep 05 '16 09:09 bertildaniel

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.

secdec24 avatar Feb 10 '17 17:02 secdec24