Giter VIP home page Giter VIP logo

jargon's Introduction

Civil service jargon

An unofficial repository of civil service jargon.

API

Lookup an acronym

Use https://matmoore.github.io/jargon/{ACRONYM}/

For example: curl https://matmoore.github.io/jargon/CO/

{
  "CO": [
    {
      "definition": "Cabinet Office",
      "uri": "government-organisation:D2"
    },
    {
      "definition": "clerical officer"
    }
  ],
  "_links": [
    {
      "name": "government-organisation",
      "href": "https://government-organisation.register.gov.uk/records/{rel}",
      "templated": true
    }
  ]
}

Get all the acronyms

curl https://matmoore.github.io/jargon/

(the structure of this response may change without notice)

CSV Data

See the data directory for more details about the data returned by the API. You can also download the data in CSV format.

Contributing

See CONTRIBUTING.md

Previewing the API locally

First run bundle exec rake build from the root of the project, then navigate to the build directory.

You can preview the JSON in the browser by running python -m http.server 8080 and browsing to localhost:8080 (this requires python 3 to be installed).

The files are generated as index.json but github pages serves them as the root for that path. See Making a JSON API with Github Pages.

If you want to see what it looks like on github pages, you can fork the repo and run bundle exec rake publish to update the gh-pages branch.

License

All code is licenced under the MIT license.

jargon's People

Contributors

dependabot[bot] avatar matmoore avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.