A static Jekyll site for the Blue Button 2.0 API splash page: https://bluebutton.cms.gov
NOTE: Internal software engineers or other interested parties should follow the documentation for running a Dockerized local development enviornment. For more information see the Dockerized Setup section.
It is assumed that the environment already has these installed:
$ gem install bundler<—install Gem bundler$ bundle install<—install Gem bundles
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.
The _codebook directory and the corresponding Jekyll plugin are used to create the variables resources, such as this one. Although these URLs show little to no usage from analytics, they are used as URIs and are integral to the Beneficiary FHIR Data (BFD) endpoint responses. For now (Dec 2021), changing the URIs would require completely retiring all of the BFD v1 and v2 APIs and releasing a new v3 with different URIs. Any additions or changes to these URIs should involve the BFD team.
We've moved the CSS for this application and our Sandbox application into a consolidated Blue Button 2.0 API CSS repository so that we can more easily keep things consistent and deploy changes more quickly.
You'll need to clone/download the BlueButton CSS repository to get started. If you're using a terminal on a Mac/Linux machine, navigate into the bluebutton-site-static repository and then run the following command:
git clone [email protected]:CMSgov/bluebutton-css.gitIf you need to make CSS changes, make them within this directory and commit them to that repository. These changes will be ignored by the git status of the bluebutton-site-static project, but you will see any CSS changes take effect locally.
For more instructions on how to make changes, view the readme inside of the bluebutton-css directory.
For information about deploying to the static site, please referernce the following document in confluence: HOW-TO Static Site Updates.
To startup the Docker containerized BB2 server, run the following command:
docker-compose up -d
Alternatively, to also monitor the web server logging:
docker-compose up -d
docker-compose logs -f | grep web
press Ctrl C will stop monitor logging.
For static site development, open the following in your browser to view the changes being developed: http://localhost:4000
After making changes, you may need to refresh your browser a few times for them to show up. You may also need to restart the web service using the following command:
docker-compose restart web
To cleanup/remove the setup run the following:
docker-compose down
docker rmi bluebutton-site-static_web