You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs/contributing/development.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,10 +2,10 @@
2
2
3
3
Hestia is an open-source project, and we welcome contributions from the community. Please read the [contributing guidelines](https://github.com/hestiacp/hestiacp/blob/main/CONTRIBUTING.md) for additional information.
4
4
5
-
Hestia is designed to be installed on a web server. To develop Hestia on your local machine, a virtual machine is recommend.
5
+
Hestia is designed to be installed on a web server. To develop Hestia on your local machine, a virtual machine is recommended.
6
6
7
7
::: warning
8
-
Development builds are unstable. If you encounter a bug please [report it via GitHub](https://github.com/hestiacp/hestiacp/issues/new/choose) or [submit a Pull Request](https://github.com/hestiacp/hestiacp/pulls).
8
+
Development builds are unstable. If you encounter a bug, please [report it via GitHub](https://github.com/hestiacp/hestiacp/issues/new/choose) or [submit a Pull Request](https://github.com/hestiacp/hestiacp/pulls).
9
9
:::
10
10
11
11
## Creating a virtual machine for development
@@ -36,21 +36,21 @@ These instructions use [Multipass](https://multipass.run/) to create an Ubuntu V
36
36
multipass mount ~/projects/hestiacp hestia-dev:/home/ubuntu/hestiacp
37
37
```
38
38
39
-
1. SSH into the VM as root then install some required packages
39
+
1. SSH into the VM as root, then install some required packages
40
40
41
41
```bash
42
42
multipass exec hestia-dev -- sudo bash
43
43
sudo apt update && sudo apt install -y jq libjq1
44
44
```
45
45
46
-
1. Navigate to `/src` in the VM then build Hestia packages
46
+
1. Navigate to `/src` in the VM, then build Hestia packages
1. Navigate to `/install` in the VM then install Hestia with these flags
53
+
1. Navigate to `/install` in the VM, then install Hestia with these flags
54
54
55
55
_(update the [installation flags](../introduction/getting-started#list-of-installation-options) to your liking, note that login credentials are set here)_
56
56
@@ -82,7 +82,7 @@ These instructions use [Multipass](https://multipass.run/) to create an Ubuntu V
82
82
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.
83
83
84
84
::: warning
85
-
Sometimes (with Multipass) the mapping between the source code directory on your local machine to the directory in the VM can be lost with a "failed to obtain exit status for remote process" error. If this happens simply unmount and remount e.g.
85
+
Sometimes (with Multipass), the mapping between the source code directory on your local machine to the directory in the VM can be lost with a "failed to obtain exit status for remote process" error. If this happens, simply unmount and remount, e.g.
86
86
87
87
```bash
88
88
multipass unmount hestia-dev
@@ -93,7 +93,7 @@ multipass mount ~/projects/hestiacp hestia-dev:/home/ubuntu/hestiacp
93
93
94
94
## Making changes to Hestia
95
95
96
-
After setting up Hestia in a development VM you can now make changes to the source code at `~/projects/hestiacp` on your local machine (outside of the VM) using your editor of choice.
96
+
After setting up Hestia in a development VM, you can now make changes to the source code at `~/projects/hestiacp` on your local machine (outside of the VM) using your editor of choice.
97
97
98
98
Below are some instructions for making a change to Hestia's UI, running the build script and testing the change locally.
0 commit comments