V_ Engineering Website

This the git repo for https://www.valtech.engineering. Pushing to main will automatically generate a new build of the site using Jekyll and is hosted on Github Pages.

Local Development

It is recommended that you use rbenv for your Ruby and GEM environment. Here is a decent guide if you need help setting up Ruby.

Install the bundler by running:

$ gem install bundler:2.1.4

To set up your development environment first run the following from the root directory of this repo:

$ bundle install

To build the site and make it available on your local machine:

$ bundle exec jekyll serve

To build the site, make it available on your local machine, and have it auto reload your browser:

$ bundle exec jekyll serve -l

Adding New Prototypes

Prototypes are stored as a Jekyll Collection. To add a new prototype complete the following:

1. Add a new file to the _prototypes directory with a relevant name such as internet-smells.md:

$ touch _prototypes/internet-smells.md

2. Add the proper front matter to the file:

---
layout: prototype
title:  "Internet Smells"
date: 2020-10-01
description: "This prototype does the impossible and makes it possible for you to smell things over the Internet."
prototype_url: "https://smelly.valtech.engineering"
repo_url: "https://github.com/valtech-sd/engineering"
license: MIT
screenshot:
vimeo:
demo: "https://smelly.valtech.engineering/images/demo.mp4"
category: "Enhanced Reality"
featured: 1
---

Required Fields: layout, title, description, category, screenshot

Optional Fields: prototype_url, repo_url, license, vimeo, demo, featured

featured: To force a prototype to be at the top of the grid set the featured key to a number. The higher the number the earlier it will appear in the grid.

vimeo: If you have a demo video that you would like to use talk to Matthew Morey about getting it on the official V_ Vimeo account.

grid video: To encode a video file for the grid, use Handbrake or something similar. For settings, use "Fast 480p30" (or something similar) for video and remove all audio streams.

3. Run Jekyll locally and make sure the site is rendering properly:

$ bundle exec jekyll serve