nf-co.re

This repository contains code for the nf-core website: http://nf-co.re/

Packages used

Here's how the website is built:

• Language: PHP
• HTML / CSS / JS framework: Bootstrap v4
• JavaScript libraries:
  • jQuery
  • Popper.js (used for bootstrap tooltips)
  • highlightjs
• PHP Markdown parsing: Parsedown and Parsedown Extra
• SVG icons: http://www.flaticon.com, https://worldvectorlogo.com/

Development

To make edits to the website, fork the repository to your own user on GitHub and then clone to your local system.

IMPORTANT: The repo has git submodules, so remember to use the --recursive flag:

git clone --recursive git@github.com:[USERNAME]/nf-co.re.git

If you forget the recursive flag (I always do), the markdown conversion won't work. You can pull the submodules when you realise this with the following command:

git submodule update --init --recursive

To run the website locally, you need a standard AMP stack: Apache, MySQL and PHP (MySQL not needed at time of writing). For this, I recommend using the free version of MAMP.

Set the base directory to /path/to/nf-co.re/public_html in Preferences > Web-Server > Document Root and then hit Start Servers.

I've built the site so that most of the hand-written text is in /markdown, to make it easier to write. The PHP files in /public_html then parse this into HTML dynamically, if supplied with a filename.

Note that the .htaccess file is set up to remove the .php file extensions in URLs.

Credits

Phil (@ewels) built this site, mostly over the course of one caffeine-fuelled evening.