Skip to content

Latest commit

 

History

History
60 lines (44 loc) · 1.74 KB

README.md

File metadata and controls

60 lines (44 loc) · 1.74 KB
Raw

OS Packager

Gitter Issues Docker Build Status Docs

The OpenSpending Packager is a Javascript application to validate source data, model it into a Fiscal Data Package, and publish data to the OpenSpending Datastore.

  • Validate tabular data sources for good structure and a consistent schema
  • Model the data into a Fiscal Data Package
  • Provide additional meta data that gives the data context
  • Publish the whole ficsal datapackage directly to OpenSpending

os-packager is written using the AngularJS framework.

Quick start

  • get the code git clone https://github.com/openspending/os-packager.git

  • install dependencies npm install

  • build the frontend assets npm run build

  • configure .env

For local development, add an .env file with the following settings:

# Required settings
# e.g. https://openspending.org or http://localhost
OS_BASE_URL=

# Optional settings
OS_SNIPPETS_GA=
OS_SNIPPETS_RAVEN=
SENTRY_DSN=
OS_PACKAGER_BASE_PATH=
POLL_INTERVAL=

# Each service will use OS_BASE_URL unless overridden by these:
OS_CONDUCTOR_URL=
OS_VIEWER_URL=
OS_ADMIN_URL=
FDP_ADAPTER_URL=

# Defaults to 'https://cosmopolitan.openspending.org/?format=json'
OS_COSMOPOLITAN_URL=

  • run the tests npm test

  • run the server npm start

  • load the app in your default browser open http://127.0.0.1:5000