IT4C.dev

This repository contains the https://www.it4c.dev Website utilizing vuepress to generate it.

Software requirements

This package requires:

nodejs
npm

Techstack

This package uses:

Usage

How to use this package

Build

Build the static files of the website which then can be found under docs/.vuepress/dist/.

npm run build

Dev

Bring up a development environment with hot reloading which can be reached under http://localhost:8080/

npm run dev

Test

Run the tests to ensure everything is working as expected

npm test

Deploy

You can use the webhook template webhook.conf.template and the deploy.sh script in .github/webhooks/ to implement an automatic deployment from a (github) webhook.

To work follow these steps (using alpine):

apk add webhook
cp .github/webhooks/webhook.conf /etc/webhook.conf
# adjust content of /etc/webhook.conf accordingly
systemctl enable webhook
systemctl start webhook

How it works

This repository utilizes vuepress-deploy to automatically deploy the current master branch to github pages.

A Pullrequest-Review-Workflow is applied to get changes into the master. From there on an automatic github workflow script utilizing vuepress-deploy is taking over. The vuepress page is built and force-pushed to the gh-pages branch, which in turn is then deployed on the github pages infrastructure and bound to the web address IT4C.dev.

1.8 KiB Raw Blame History