Skip to content
Informational site for BCDA
CSS HTML Ruby JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github BCDA-1612: Add PR template. Aug 2, 2019
Dockerfiles use entrypoint instead of cmd in dockerfile Jul 25, 2019
_includes
_layouts fix file perms Sep 16, 2019
assets Update data dict file (#5) Sep 18, 2019
common minor edits based on @epfrankle's review Sep 17, 2019
production add 'setting up creds in swagger' sections to prod and sandbox user g… Sep 17, 2019
sandbox add 'setting up creds in swagger' sections to prod and sandbox user g… Sep 17, 2019
.gitignore BCDA-1612: Updates to static site build process. Aug 1, 2019
404.html fix file perms Sep 16, 2019
Gemfile fix file perms Sep 16, 2019
Gemfile.lock fix file perms Sep 16, 2019
README.md BCDA-1612: Fix text formatting in README. Aug 1, 2019
_config.yml fix file perms Sep 16, 2019
docker-compose.yml initial commit Jun 29, 2019
index.md minor edits based on @epfrankle's review Sep 17, 2019

README.md

Beneficiary Claims Data API

A static Jekyll site for the BCDA splash page: https://sandbox.bcda.cms.gov

Requirements

It is assumed that the environment already has these installed:

  • rbenv or rvm to install versioned ruby
  • ruby currently using 2.4
  • jekyll currently using 3.5.2

Installation

  1. $ gem install bundler <—install Gem bundler
  2. $ bundle install <—install Gem bundles

Build

Jekyll builds the CSS and HTML pages. Run bundle exec jekyll serve from the project root for a local build. By default, the site will run in http://localhost:4000/. You can also run bundle exec jekyll build to compile the site files into the _site directory.

Using Docker for builds

Consistent and simple build process:

docker-compose -f docker-compose.yml build static_site
docker-compose -f docker-compose.yml run --rm static_site

This process uses a Docker container to execute bundle exec jekyll build , compiling site files ino the same _site directory used when executing this command on the Docker host. Advantage here is that there's no need to install ruby or any dependencies on the machine building the static site — Docker takes care of all that.

Using Docker for serving

To host the site in Docker, accessible at http://localhost:4000/:

docker-compose run --publish 4000:4000 --rm --entrypoint "bundle exec jekyll serve -H 0.0.0.0" static_site

This is a convenience meant to ease integration of static site builds with the larger BCDA CI/CD pipeline.

You can’t perform that action at this time.