(Work in progress) Application for managing organisations, people and roles within GOV.UK
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
bin
config
db
lib
log
public
spec
tmp
vendor
.gitignore
.rspec
.rubocop.yml
.ruby-version
Gemfile
Gemfile.lock
Jenkinsfile
LICENCE
Procfile
README.md
Rakefile
config.ru
package.json

README.md

Organisations-publisher

One paragraph description and purpose.

Screenshots (if there's a client-facing aspect of it)

Live examples (if available)

Nomenclature

  • Word: definition of word, and how it's used in the code

Technical documentation

Write a single paragraph including a general technical overview of the app. Example:

This is a Ruby on Rails application that maps RESTful URLs onto a persistence layer. It's only presented as an internal API and doesn't face public users.

Dependencies

Running the application

./startup.sh

Documentation for where the app will appear (default port, vhost, URL etc).

Running the test suite

bundle exec rake

Include any other edge cases, e.g parallel test runner in Whitehall

Any deviations from idiomatic Rails/Go etc. (optional)

Example API output (optional)

one-line-curl-command with JSON response after

Keep this section limited to core endpoints - if the app is complex link out to /docs.

Licence

MIT License