Budget Key Project

What is this about?

The Budget Key project aims at being the most up to date and comprehensive non-governmental database of Israeli fiscal data.

It has user-facing website (currently available at obudget.org), using multiple API servers which are running of maticulously collected data from various sources, manually improved and cleaned.

The data can also be queried using a relational query interface, available at data.obudget.org (use any Google account to log in after clicking 'Login with Google').

Where to start?

• Find an interesting task to start with
  • Some of our starter issues are marked with a 'help wanted' label. See here a list of all these isssues
  • You can ping us on Slack (preferrably), on gitter.im (https://gitter.im/OpenBudget/BudgetKey) or on Telegram (ask to join)
  • Consult with Adam, Mushon, Saar or Mary to find the best match for you.
• Read a little about our workflow
• See the HowTos below to understand our development environment.
• Read the documentation, if you need to dive deep in existing code

HowTos

• Front End Development (Angular2 / HTML / CSS / Node ... )
• Data Wrangling (Python3)
• Using the API

Repositories

This is the main repository, where documentation should come.

Issues and pull requests should be made on the individual repositories:

• Frontend apps:
  • Search page: https://github.com/OpenBudget/budgetkey-app-search
  • Item page: https://github.com/OpenBudget/budgetkey-app-budget-item
  • Main page: https://github.com/OpenBudget/budgetkey-app-main-page
• Backend services:
  • Search API: https://github.com/OpenBudget/open-budget-search-api
  • Data API: https://github.com/OpenBudget/open-budget-data-api
  • List Manager API: https://github.com/OpenBudget/budgetkey-list-manager
  • Nginx Frontend: https://github.com/OpenBudget/open-budget-nginx-frontend
  • ElasticSearch service: https://github.com/OpenBudget/open-budget-elasticsearch
• Frontend Libraries:
  • Common Angular2 Components: https://github.com/OpenBudget/budgetkey-ng2-components
  • Authentication utilities: https://github.com/OpenBudget/budgetkey-ng2-auth
  • A Specialized Sankey Component: https://github.com/OpenBudget/mushonkey
• Data pipeline:
  • https://github.com/OpenBudget/budgetkey-data-pipelines
• DevOps:
  • Kubernetes Infrastructure: https://github.com/OpenBudget/budgetkey-k8s
• BudgetKey portals:
  • SocialMap: https://github.com/OpenBudget/socialmap-app-main-page
  • OpenProcure: https://github.com/OpenBudget/openprocure-app-main-page