Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(other): new it4c dev website #58

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
201 changes: 0 additions & 201 deletions LICENSE

This file was deleted.

52 changes: 4 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,7 @@
# IT4C.dev
# Vue 3 + Vite

This repository contains the https://www.it4c.dev Website utilizing `vuepress` to generate it.
This template should help get you started developing with Vue 3 in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.

## Software requirements
## Recommended IDE Setup

This package requires:
- [nodejs](https://github.com/nodejs/node)
- [npm](https://github.com/npm/cli)

## Techstack

This package uses:
- [vuepress](https://github.com/vuejs/vuepress)
- [vuepress-theme-book](https://github.com/cyrilf/vuepress-theme-book)
- [vuepress-deploy](https://github.com/jenkey2011/vuepress-deploy)

## 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
```

## How it works

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

![repo-architecture](./docs/images/docs/architecture.png)

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](https://www.it4c.dev).
- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
69 changes: 0 additions & 69 deletions docs/.vuepress/config.js

This file was deleted.

21 changes: 0 additions & 21 deletions docs/contact.md

This file was deleted.

4 changes: 0 additions & 4 deletions docs/history.md

This file was deleted.

Loading