/sims-website

Primary LanguageJavaScript

SIMS

rcrcsims.org

Contributing

Update network directory

  • Copy a person's profile /app/_network/first-last.md and rename it
  • Add a 1:1 aspect ratio picture to app/assets/img/network/
  • Add a logo for your National society to app/assets/img/ns/

Update toolkit

  • TODO

Update gallery images

  • add files to the dropbox in rcrcsims/gallery/
  • each new image requires two files with identical names except one has _THUMB appended, for example EbolaCasesTimeSeries_THUMB.png and EbolaCasesTimeSeries.png
  • file type should be .jpg, .jpeg, or .png
  • the thumbnail should have a 1:1 aspect ratio, at least 150x150 pixels (though they currently display at 88x88), and as small as possible (less than 50kb)
  • the full size image can probably have height < 900px for portrait or width < 1200px for landscape and should be around 500kb or less

Development

Environment

To set up the development environment for this website, you'll need to install the following on your system:

  • Install nvm
  • nvm use
  • rvm and Bundler
  • rvm use 2.3.1
  • Gulp ( $ npm istall -g gulp )

After these basic requirements are met, run the following commands in the website's folder:

$ npm install

Will also run bundle install

Getting started

$ gulp serve

Compiles the compass files, javascripts, and launches the server making the site available at http://localhost:3000/ The system will watch files and execute tasks whenever one of them changes. The site will automatically refresh since it is bundled with livereload.

The _config-dev.yml file will be loaded alongside _config.yml.

Other commands

Clean the compiled site. I.e. the _site folder

$ gulp clean

Compile the compass files, javascripts, and builds the jekyll site using _config-dev.yml. Use this instead of gulp serve if you don't want to watch.

$ gulp

Compiles the site loading the _config-prod.yml alongside _config.yml. The javascript files will be minified.

$ gulp prod