https://github.com/dreamsparkx/flask-boilerplate

https://github.com/dreamsparkx/flask-boilerplate

Last synced: 5 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/dreamsparkx/flask-boilerplate
• Owner: dreamsparkx
• Created: 2023-04-13T17:31:45.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-11T07:24:08.000Z (over 1 year ago)
• Last Synced: 2025-01-10T22:43:08.419Z (6 months ago)
• Language: Python
• Size: 24.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Flaskr

======

![main.yml workflow](https://github.com/dreamsparkx/flask-boilerplate/actions/workflows/python-app.yml/badge.svg)

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/dreamsparkx/flask-boilerplate

    $ cd flask-boilerplate

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