florence

README

Florence

The publishing platform used for the ONS website.


Getting started

To run Florence you must have Golang installed on a UNIX machine.

Once you have installed those dependencies and cloned this repo you need to run the following:

1. Move into the correct directory

cd florence

1. Run the server

make debug

1. Browse to the Florence homepage http://localhost:8081/florence/index.html

2. If you are running Florence for the first time you will need to login with the setup credentials. You will be asked to change this password.

Username: florence@magicroundabout.ons.gov.uk Password: Doug4l

Optional (for developing Florence)

1. Install NodeJS and NPM
2. Watch for JS, CSS and other source file changes

make watch-src

Configuration

The following environment variables are available when running the Go server.

Environment variable	Default	Description
BIND_ADDR	:8080	Host and port to bind to
BABBAGE_URL	http://localhost:8080	URL that Babbage can be accessed on
ZEBEDEE_URL	http://localhost:8081	The URL that Zebedee can be accessed on
ENABLE_NEW_APP	false	When true the refactored Florence JS application will be available on /florence, otherwise it'll host the current Florence application

For example:

make debug BIND_ADDR=:20000

Contributing

See CONTRIBUTING for details.

License

Copyright © 2016-2017, Office for National Statistics (https://www.ons.gov.uk)

Released under MIT license, see LICENSE for details.