CLI
The CLI tool is used to generate the static api endpoints that power the website. For how to install the CLI see the README.md of af-election-api.
Commands
There are two main commands:
Results
Generate the API endpoints with the results data.
$ yarn api results [options] <electionId>
<electionId>
- as specified inconfig.js
Options:
--production
- Upload the generated files to S3. By default, this script will generate the full file structure in the./tmp
folder of the root of the project.
Config
Generate the API endpoints with the election configuration.
$ yarn api config [options] <electionId>
<electionId>
- as specified inconfig.js
. This will generate the given election's config file, the election's trends index and the individual trends config. If the<electionId>
is set asglobal
the global app configuration will be generated instead. This includes theconfig
with the election list, and the data for the about page.
Options:
--production
- Upload the generated files to S3. By default, this script will generate the full file structure in the./tmp
folder of the root of the project.