Project Tetra - Project Repository

This repository contains the content and source code for generating the Project Tetra site. For more information about Project Tetra, please visit https://tetrabiodistributed.github.io/project-tetra-docs

This Project is hosted at https://tetrabiodistributed.github.io

Prerequisites

The following are basic prerequisites for previewing the Project Tetra site on your local machine:

• Install Hugo for your specific platform. If you install from the release page, make sure you download the _extended version which supports SCSS.

Cloning the Project Tetra Project

The following will clone the project repository onto your local machine. This will allow you to edit and preview changes to the project site (don’t forget to use --recurse-submodules or you won’t pull down some of the code you need to generate a working site).

git clone --recurse-submodules --depth 1 https://github.com/tetrabiodistributed/project-tetra-docs.git
cd project-tetra

Running the website locally

Once you’ve cloned the project repo, you can run your own local Hugo server via the following options:

Option 1: Using Hugo + Asciidoctor (Recommended for Linux & MacOS users)

1. Follow the instructions in Getting started to install Hugo. You’ll need at least Hugo version 0.68.3. If you install from the release page, make sure you download the _extended version which supports SCSS.

2. You will also need to install Asciidoctor.

3. Run serve.sh script in the site root directory. By default your site will be available at http://localhost:1313. Hugo will watch for changes to the content and automatically refresh your site.

 sh serve.sh

Note	You will also need Graphviz (2.38.0 recommended) and Plantuml installed in order to be able to render UML diagrams.

Option 2: Using Docker (Recommended for Windows users)

1. Install docker.

2. Run the following command in the site root directory. By default your site will be available at http://localhost:1313. Hugo will watch for changes to the content and automatically refresh your site.

 docker run --rm --volume $PWD:/src -p 1313:1313 -w "/src" bwklein/hugo-asciidoctor sh serve.sh