Skip to content

Latest commit

 

History

History
55 lines (38 loc) · 3.14 KB

readme.rst

File metadata and controls

55 lines (38 loc) · 3.14 KB
Raw

elections24-general

This news app is built on our interactive template. Check the readme for that template for more details about the structure and mechanics of the app, as well as how to start your own project.

Documentation about pages and components lives in src/js/components/readme.md.

Getting started

To run this project you will need:

  • Node installed (preferably with NVM or another version manager)
  • The Grunt CLI (install globally with npm i -g grunt-cli)
  • Git

With those installed, you can then set the project up using your terminal:

  1. Pull the code - git clone [email protected]:nprapps/elections24-general
  2. Enter the project folder - cd elections24-general
  3. Install dependencies from NPM - npm install
  4. Update local data from Google Sheets/Docs - grunt sheets docs
  5. Start the server - grunt

Running tasks

Like all interactive-template projects, this application uses the Grunt task runner to handle various build steps and deployment processes. To see all tasks available, run grunt --help. grunt by itself will run the "default" task, which processes data and starts the development server. However, you can also specify a list of steps as arguments to Grunt, and it will run those in sequence. For example, you can just update the JavaScript and CSS assets in the build folder by using grunt bundle less.

Common tasks that you may want to run include:

  • sheets - updates local data from Google Sheets
  • docs - updates local data from Google Docs
  • google-auth - authenticates your account against Google for private files
  • static - rebuilds files but doesn't start the dev server
  • cron - runs builds and deploys on a timer (see tasks/cron.js for details)
  • publish - uploads files to the staging S3 bucket
    • publish:live uploads to production
    • publish:simulated does a dry run of uploaded files and their compressed sizes

Notable flags and combinations of tasks:

  • grunt local --APtest — run an AP test on your local machine on a 60-second cron
  • grunt --offline — run the project with the AP data you have locally
  • grunt clean sheets docs static publish:live — republishes assets + code to the live server but doesn’t touch the data (helpful when results are live)
  • grunt update — pull the latest content from associated sheets, docs and sync
  • grunt replay --offline --seconds=30 — locally replay a previously-recorded AP test, refreshing the data every 30 seconds (the seconds flag is optional)

Troubleshooting

Fatal error: Port 35729 is already in use by another process.

The live reload port is shared between this and other applications. If you're running another interactive-template project or Dailygraphics Next, they may collide. If that's the case, use --reload-port=XXXXX to set a different port for the live reload server. You can also specify a port for the webserver with --port=XXXX, although the app will automatically find the first available port after 8000 for you.