Skip to content

Commit 219dbf7

Browse files
authored
Tidy development docs (hestiacp#3677)
1 parent 459797d commit 219dbf7

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

docs/docs/contributing/development.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -51,16 +51,21 @@ multipass mount $HOME/projects/hestiacp hestia-dev:/home/ubuntu/hestiacp
5151
sudo apt update && sudo apt install -y jq libjq1
5252
```
5353

54-
1. Install [Node JS](https://nodejs.org/)
54+
1. Outside of the VM (in a new terminal) ensure [Node.js](https://nodejs.org/)
55+
16 or later is installed
5556

56-
1. Build the theme files with
57+
```bash
58+
node --version
59+
```
60+
61+
1. Install dependencies and build the theme files:
5762

5863
```bash
5964
npm install
6065
npm run build
6166
```
6267

63-
1. Navigate to `/src` and build Hestia packages
68+
1. Back in the VM terminal, navigate to `/src` and build Hestia packages
6469

6570
```bash
6671
cd src
@@ -76,7 +81,7 @@ multipass mount $HOME/projects/hestiacp hestia-dev:/home/ubuntu/hestiacp
7681
bash hst-install-ubuntu.sh -D /tmp/hestiacp-src/deb/ --interactive no --email admin@example.com --password Password123 --hostname demo.hestiacp.com -f
7782
```
7883

79-
1. Reboot VM (and exit SSH session)
84+
1. Reboot the VM (and exit SSH session)
8085

8186
```bash
8287
reboot
@@ -90,21 +95,21 @@ multipass mount $HOME/projects/hestiacp hestia-dev:/home/ubuntu/hestiacp
9095

9196
1. Visit the VM's IP address in your browser using the default Hestia port and login with `admin`/`Password123`
9297

93-
_(bypass any SSL errors you see when loading the page)_
98+
_(proceed past any SSL errors you see when loading the page)_
9499

95100
```bash
96101
e.g. https://192.168.64.15:8083
97102
```
98103

99-
Hestia is now running in a virtual machine. If you'd like to make changes to the source code and test them, please continue to the next section.
104+
Hestia is now running in a virtual machine. If you'd like to make changes to the source code and test them in your browser, please continue to the next section.
100105

101106
## Making changes to Hestia
102107

103-
After setting up Hestia in a VM you can now make changes to the source code in `$HOME/projects/hestiacp` on your local machine using your editor of choice.
108+
After setting up Hestia in a VM you can now make changes to the source code at `$HOME/projects/hestiacp` on your local machine (outside of the VM) using your editor of choice.
104109

105110
The following are example instructions for making a change to Hestia's UI and testing it locally.
106111

107-
1. At the root of the project on your local machine, install Node dependencies
112+
1. At the root of the project on your local machine, ensure the latest packages are installed
108113

109114
```bash
110115
npm install
@@ -142,7 +147,7 @@ Please refer to the [contributing guidelines](https://github.com/hestiacp/hestia
142147

143148
## Running automated tests
144149

145-
For automated tests we currently use [Bats](https://github.com/bats-core/bats-core).
150+
We currently use [Bats](https://github.com/bats-core/bats-core) to run our automated tests.
146151

147152
### Install
148153

0 commit comments

Comments
 (0)