Skip to content

eycramer/covid19-forecast-hub-web

 
 

Repository files navigation

CI

Running Your Site Locally

  1. Install a full Ruby development environment

  2. Install Jekyll and Bundler

     gem install jekyll
     gem install bundler -v 1.16.6
    
  3. Install dependencies from Gemfile:

     bundle install
    
  4. Build the site and make it available on a local server

     bundle exec jekyll serve
    
  5. Browse to http://localhost:4000

Build the site and deploy on GitHub Pages

  1. Run this bash script in the root directory of this repository

     ./deploy.sh
    

The community file generation takes time and if you want to skip this step (this is anyways updated daily by the CI), you can run with the skip_gen flag:

    ./deploy.sh skip_gen

Add weekly reports

  1. Add the HTML file in the reports directory.
  2. Add an entry in the /doc/reports/index.md file to link to /reports/[name-of-html-file] based on the template already added in that file.
  3. Additionally, you could also deploy the site after adding the weekly report from GitHub Actions here.
    Press the Run workflow button and if you want to skip the community generation step (it takes time!), specify skip_gen in the Arguments to deploy script field. Click Run workflow.

Add a talk

  1. If it is a PDF (or any other static file), you can add the file in the talks folder and the url to link would just be /talks/[filename_with_extension]. Ignore this step if it you want to add an existing URL.
  2. Add an item to the list here. You can use the following line as a template if you want:
- Talk name [link](https://link-to-your-talk.com){:target="_blank"} (Date)

About

Source for the COVID 19 forecast hub website

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 100.0%