open-traffic-count-microsite

• open-traffic-count-microsite
  • About
  • Getting Started
    • Prerequisites
    • Installing
    • Development
  • Deployment

About

This is a microsite build with Jekyll for the Open Traffic Count Project

Getting Started

Prerequisites

You will need

• Ruby >= 2.6 (install with rbenv)
• bundler (install with ruby gems gem install bundler)
• Node.js >= 12 (install with nvm)

Installing

git clone https://github.com/technologiestiftung/open-traffic-count-microsite.git
cd open-traffic-count-microsite
# Will check dependencies and give you hints what is missing
# Does NOT autoinstall Ruby and bundler
# It will run `bundle install` for you
./tools/install.sh

Development

All files that are used for the actual site are located in the src folder. The entrypoint to the site is index.md.

To run the Jekyll with "livereload" enabled you need to execute:

bundle exec jekyll serve --livereload

For compiling scss and ts you need to run:

npm run webpack:dev

For convenience this is combined in the the command:

npm run dev

Use CTRL + C to stop the server.

Deployment

The site is deployed through git hooks to Netlify. You will need to:

• Create a new branch git checkout -b my-new-feature
• Push the branch to the remote git push origin my-new-feature
• Open a pull request for review.

Do not push to master directly!