IT4Change/IT4C.dev
3
0
Fork 0
mirror of https://github.com/IT4Change/IT4C.dev.git synced 2025-12-13 09:25:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #129 from IT4Change/fix-md-remarks

Browse Source 
fix(content): md remarks
This commit is contained in:
Hannes Heine 2024-02-07 10:52:33 +01:00 committed by GitHub
commit 860b5b467c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,16 +1,18 @@
# IT4C.dev # IT4C.dev
This repository contains the https://www.it4c.dev Website utilizing `vuepress` to generate it. This repository contains the [Website](https://www.it4c.dev) utilizing `vuepress` to generate it.
## Software requirements ## Software requirements
This package requires: This package requires:
- [nodejs](https://github.com/nodejs/node) - [nodejs](https://github.com/nodejs/node)
- [npm](https://github.com/npm/cli) - [npm](https://github.com/npm/cli)
## Techstack ## Techstack
This package uses: This package uses:
- [vuepress](https://github.com/vuejs/vuepress) - [vuepress](https://github.com/vuejs/vuepress)
- [vuepress-theme-book](https://github.com/cyrilf/vuepress-theme-book) - [vuepress-theme-book](https://github.com/cyrilf/vuepress-theme-book)
- [vuepress-deploy](https://github.com/jenkey2011/vuepress-deploy) - [vuepress-deploy](https://github.com/jenkey2011/vuepress-deploy)
@ -22,15 +24,16 @@ How to use this package
### Build ### Build
Build the static files of the website which then can be found under `docs/.vuepress/dist/`. Build the static files of the website which then can be found under `docs/.vuepress/dist/`.
```
```bash
npm run build npm run build
``` ```
### Dev ### Dev
Bring up a development environment with hot reloading which can be reached under http://localhost:8080/ Bring up a development environment with hot reloading which can be reached [under](http://localhost:8080/)
``` ```bash
npm run dev npm run dev
``` ```
@ -38,7 +41,7 @@ npm run dev
Run the tests to ensure everything is working as expected Run the tests to ensure everything is working as expected
``` ```bash
npm test npm test
``` ```
@ -47,6 +50,7 @@ npm test
You can use the webhook template `webhook.conf.template` and the `deploy.sh` script in `.github/webhooks/` for an automatic deployment from a (github) webhook. You can use the webhook template `webhook.conf.template` and the `deploy.sh` script in `.github/webhooks/` for an automatic deployment from a (github) webhook.
For this to work follow these steps (using alpine): For this to work follow these steps (using alpine):
```bash ```bash
apk add webhook apk add webhook
cp .github/webhooks/hooks.json.template .github/webhooks/hooks.json cp .github/webhooks/hooks.json.template .github/webhooks/hooks.json

1
docs/projects/gradido.md
View File

@ -2,6 +2,5 @@
Describe Project, Stechstack etc Describe Project, Stechstack etc
Projekte werden bebildert, der Techstack aufgeführt, sowie beteiligte Personen aus dem Team. Projekte werden bebildert, der Techstack aufgeführt, sowie beteiligte Personen aus dem Team.
Idealerweise würden diese Daten von github kommen (später) Idealerweise würden diese Daten von github kommen (später)