flask/examples/tutorial/README.rst
David Lord 24df8fc89d
show 'run --debug' in docs
Reverts commit 4d69165ab6. Now that a
release has this option, it's ok to show it in the docs. It had been
reverted because the 2.2.x docs showed it before 2.2.3 was released.
2023-02-15 14:33:32 -08:00

68 lines
1.2 KiB
ReStructuredText

Flaskr
======
The basic blog app built in the Flask `tutorial`_.
.. _tutorial: https://flask.palletsprojects.com/tutorial/
Install
-------
**Be sure to use the same version of the code as the version of the docs
you're reading.** You probably want the latest tagged version, but the
default Git version is the main branch. ::
# clone the repository
$ git clone https://github.com/pallets/flask
$ cd flask
# checkout the correct version
$ git tag # shows the tagged versions
$ git checkout latest-tag-found-above
$ cd examples/tutorial
Create a virtualenv and activate it::
$ python3 -m venv venv
$ . venv/bin/activate
Or on Windows cmd::
$ py -3 -m venv venv
$ venv\Scripts\activate.bat
Install Flaskr::
$ pip install -e .
Or if you are using the main branch, install Flask from source before
installing Flaskr::
$ pip install -e ../..
$ pip install -e .
Run
---
.. code-block:: text
$ flask --app flaskr init-db
$ flask --app flaskr run --debug
Open http://127.0.0.1:5000 in a browser.
Test
----
::
$ pip install '.[test]'
$ pytest
Run with coverage report::
$ coverage run -m pytest
$ coverage report
$ coverage html # open htmlcov/index.html in a browser