Skip to content

Latest commit

 

History

History
57 lines (45 loc) · 1.89 KB

README.md

File metadata and controls

57 lines (45 loc) · 1.89 KB
Raw

CBC Projects Index Page

Travis License

Overview

Node-Hugo project that generates Brown's Computational Biology Core's Projects Index Website. We use Node.js to access GitHub's REST API and retrieve information about CBC's projects' repositories. The data is processed and written to data/ which can then be used by Hugo to generate static pages. The website is continuously deployed to GitHub Pages using Travis CI.

Getting Started

Prerequisites

Install

Install dependencies:

npm install

Set up .env file with GitHub Access Token

Sensitive environment variables are stored in the .env file. This file is included in .gitignore intentionally, so that it is never committed.

  • Create a .env file and copy into it the contents of .env.template
  • Get your GitHub Access Token and add to the .env file.

Local development

Get the data

gulp data

Start gulp to watch and compile .sass

# in a terminal window
gulp

Start the server

# in a different terminal window
hugo serve -D

Build site locally

This will build the site in the public/ directory.

hugo

Deployment

The site is deployed to GitHub Pages using Travis. Changes to the site should be done in the Hugo project (hugo-site branch). Never commit to master, that branch will be updated by Travis whenever a new build is done.