LandRegistry/govuk-flask-skeleton

Name: govuk-flask-skeleton

Owner: HM Land Registry

Description: null

Created: 2015-04-15 08:56:52.0

Updated: 2015-05-05 16:02:02.0

Pushed: 2015-09-23 08:25:28.0

Homepage: null

Size: 500

Language: Python

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

GOV.UK-flask-skeleton

This is a template project for building frontends using the gov.uk toolkit using flask.

Contents

• Usage
• Getting Started
• Acceptance Tests
• Code Style Checking

Usage

    /helloworld                 # test endpoint for the app

Getting Started

1. Clone the repo

2. Get the GOV.UK toolkit submodule

   submodule update --init
   

3. In the directory enter the command

   install -r requirements.txt
   

4. To run the application run the command

   on run.py runserver
   

Acceptance Tests

• Standard way

  ceptance-tests/run_tests.sh
  

• Cut down version of output

  ceptance-tests/run_tests.sh --format progress
  

• Only run test with specific tag

  ceptance-tests/run_tests.sh --tags @USXX
  

Code Style Checking

1. App

   e8 .
   

   Requires flake8, install with `pip install flake8`

2. Acceptance tests

   ceptance-tests/run_linting.sh