Table of Contents
This section of the OpenSpending documentation is for developers. Here you can learn about the design of the platform, and how to get OpenSpending running locally or on your own servers, and the process for contributing enhancements and bug fixes to the code.
- Getting started
- Views (babbage.ui)
- Auth Client
- Status and Incident Notifications
- Theming Guide
- Contributing Code
Let's get started then! If you want to get the whole OpenSpending platform running locally, or deployed to your own servers, then go straight to the platform section of the documentation. For details on distinct components, go to the appropriate section from the list below.
OpenSpending as a complete platform is a set of Docker containers, run via Docker Compose in development. Configurations are available to get running quickly on a local machine, and pre-built Docker images are available for deployment to a remote server for production use. Details to run the platform are available in the central github repository README: https://github.com/openspending/openspending
The OpenSpending Datastore is a flat file datastore with source data stored in Fiscal Data Packages.
The OpenSpending API offers a rich suite of methods to query the database.
A set of integration web services for OpenSpending, responsible for identity, notification, and access control.
Error monitoring with Sentry is supported for several of the OpenSpending applications. To configure an application container for Sentry, add the appropriate DSN value as an environmental variable. Sentry DSN values can be found within the Sentry project settings > Client Keys (DSN).
Add the environmental variable
SENTRY_DSN with the appropriate private Sentry DSN value for each of the following containers:
The following applications require the public Sentry DSN key, as it is used by client-side code. Add the environmental variable
SENTRY_PUBLIC_DSN with the public Sentry DSN value for each of the following containers:
- os-viewer (os-viewer uses both the private and public DSN keys)
Status and Incident Notifications
Application availability status for the OpenSpending website and the OpenSpending API is automatically monitored and available from the OpenSpending status dashboard: https://status.openspending.org/.
Users can subscribe to receive notifications about the availability status of OpenSpending, and other ad-hoc incident reports such as scheduled maintenance, from the status dashboard. Click the 'Subscribe' button at the bottom of the page to receive email notifications, or subscribe to the RSS/Atom feeds.
Found a bug? Got neat way to refactor an existing code path? Bursting with ideas to make OpenSpending more awesome?
We can't wait to see your contributions. Here are a few things that will help:
- All open issues can be found here. If you are working on an existing issue, please let us know by commenting on an issue. Likewise, if you are working on something new, open an issue to let us know.
If anything is unclear, or you just want to talk with other people working on OpenSpending, then catch us on Gitter.im.