Skip to content

Latest commit

 

History

History
24 lines (13 loc) · 1.35 KB

readme.md

File metadata and controls

24 lines (13 loc) · 1.35 KB
Raw

Readme

This /docs directory contains the Github Pages source code for the website where you can learn more about the project and principles.

Get started

To make changes to the website, you can edit the files directly in github, or, set it up locally. Once a pull-request has been approved and merged into the main branch, the site will re-build with those changes.

Local set-up

  1. Clone the repository locally:
gh repo clone Open-Health-Manager/Design

  1. The site is built using ruby, jekyll, and bundler. The GitHub Docs are also a good resource.

  2. Next, run bundle install in the /docs directory.

  3. Finally, in the /docs directory run a local server using bundle exec jekyll serve and develop! You might want to develop on a separate branch from main, then create a pull request to merge your branch into main when your changes are ready for review.

Note: Ruby must be up to date to 3.1.2, for mac instructions for updating ruby (gloabally accross system) check here: https://mac.install.guide/ruby/13.html