Global Config
The main configuration file for the website is the config.js
found at the root of af-elections-api. This file defines which elections will be present on the website.
Properties:
destinationBucket<String>
- AWS S3 bucket to store the dataelections<Array[Object]>
- List of elections to display on the websiteid<String>
- Id of the electionpreliminary<Boolean>
- Whether or not the election has preliminary vote resultstype<String>
- Either "parliamentary" or "presidential"levels<Array[String]>
- Level for which there is election data (provinces, districts, pollingCenters)dataUrl<String>
- Base url for the election data. It will most likely behttps://raw.githubusercontent.com/developmentseed/af-elections-data/master/<electionId>
rounds<Array[Object]>
- List of election rounds. If the election has rounds, thepreliminary
,levels
, anddataUrl
are set on a round level rather than on election levelid<String>
- Id of the election roundpreliminary<Boolean>
- Whether or not the round has preliminary vote resultslevels<Array[String]>
- Level for which there is election data (provinces, districts, pollingCenters)dataUrl<String>
- Base url for the election data
Example
{
'destinationBucket': 'af-elections',
'elections': [
{
'id': '2004-presidential',
'preliminary': false,
'type': 'presidential',
'levels': [ 'provinces' ],
'dataUrl': `https://raw.githubusercontent.com/developmentseed/af-elections-data/master/2004-presidential`
},
{
'id': '2014-presidential',
'type': 'presidential',
'rounds': [
{
'id': 'first',
'preliminary': false,
'levels': [ 'provinces', 'districts', 'pollingCenters' ],
'dataUrl': `https://raw.githubusercontent.com/developmentseed/af-elections-data/master/2014-presidential-firstround`
},
'...': '...'
]
},
{
'id': '2018-wolesi-jirga',
'preliminary': true,
'type': 'parliamentary',
'levels': [ 'provinces', 'districts', 'pollingCenters' ],
'dataUrl': `https://raw.githubusercontent.com/developmentseed/af-elections-data/master/2018-wolesi-jirga`
},
'...': '...'
]
}
API
The global configuration endpoint can be generated using the CLI command:
$ yarn api config global
/config.json
The global configuration defines the base information variables for the application to work.
{
"version": "1.0.0",
"elections": [
{
"id": "2018-wolesi-jirga",
"name": "Wolesi Jirga",
"year": 2018,
"type": "parliamentary",
},
"..."
}