IT4C.dev/README.md

43 lines
622 B
Markdown

# 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:
- vuepress
- vuepress-theme-book
## 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
```