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.

Sign up for GitHub

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

docs(other): document how to install via npm and reference the correct node version #43

Closed
wants to merge 4 commits into from
Closed

docs(other): document how to install via npm and reference the correct node version #43

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
98aacd5
document how to install via npm and reference the correct node version
ulfgebhardt Feb 15, 2023
8cac796
Merge branch 'master' into readme_install_node
ulfgebhardt Feb 21, 2023
83118e3
Merge branch 'master' into readme_install_node
mahula Oct 3, 2023
f2c49c4
Merge branch 'master' into readme_install_node
ulfgebhardt Nov 5, 2023
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
19 changes: 14 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This repository contains the https://www.it4c.dev Website utilizing `vuepress` t
## Software requirements

This package requires:
- [nodejs](https://github.com/nodejs/node)
- [nodejs 17+](https://github.com/nodejs/node)
- [npm](https://github.com/npm/cli)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

May be also refer to nvm: https://github.com/nvm-sh/nvm

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We do not have a nvm setting yet

Copy link
Member

@mahula mahula Oct 3, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now we have it.
https://github.com/IT4Change/IT4C.dev/blob/master/.nvmrc
It sets Node v19 as default.


## Techstack
Expand All @@ -19,26 +19,35 @@ This package uses:

How to use this package

### Install
To get started the required packages must be installed.

```sh
npm install
```

Also make sure you have the correct `nodejs` version referenced above to ensure everything works as intended.

### Build

Build the static files of the website which then can be found under `docs/.vuepress/dist/`.
```
```sh
npm run build
```

### 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/](http://localhost:8080/)

```
```sh
npm run dev
```

### Test

Run the tests to ensure everything is working as expected

```
```sh
npm test
```

Expand Down