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
While not a hard requirement it's also probably a good idea to install `node` 18
18
+
*[Node 18](https://nodejs.org/dist/latest-v18.x/)
21
19
22
20
## Installation
23
21
@@ -28,8 +26,8 @@ git clone https://github.com/lando/mailhog.git && cd mailhog
28
26
# Install dependencies with lando
29
27
lando start
30
28
31
-
# Or install them with yarn
32
-
yarn
29
+
# Or install them with npm
30
+
npm install
33
31
```
34
32
35
33
## Working
@@ -60,10 +58,10 @@ If you want to help with contributing documentation here are some useful command
60
58
61
59
```bash
62
60
# launch local docs site
63
-
yarn docs:dev
61
+
npm run docs:dev
64
62
65
63
# build docs locally
66
-
yarn docs:build
64
+
npm run docs:build
67
65
```
68
66
69
67
If you are more interested in the internals of the docs they use [VuePress2](https://v2.vuepress.vuejs.org/) and our [Special theme](https://vuepress-theme-default-plus.lando.dev).
@@ -88,7 +86,7 @@ And then you can run the tests with the below.
88
86
89
87
```bash
90
88
# Run unit tests
91
-
yarn test:unit
89
+
npm run test:unit
92
90
```
93
91
94
92
### Leia Tests
@@ -115,21 +113,21 @@ Destroy tests
115
113
lando destroy -y
116
114
```
117
115
118
-
Note that the headers here are important and are defined in our `yarn generate:tests` script. The _Start up tests_ header specifies things that should run before the main series of tests. _Verification commands_ is the main body of tests and is required. _Destroy tests_ specifies any needed clean up commands to run.
116
+
Note that the headers here are important and are defined in our `npm run generate:tests` script. The _Start up tests_ header specifies things that should run before the main series of tests. _Verification commands_ is the main body of tests and is required. _Destroy tests_ specifies any needed clean up commands to run.
119
117
120
118
If you check out the various READMEs in our [examples](https://github.com/lando/mailhog/tree/main/examples) you will notice that they are all Leia tests.
121
119
122
120
Before running all or some of the tests you will need to generate them.
123
121
124
122
```bash
125
123
# Generate tests
126
-
yarn generate:tests
124
+
npm run generate:tests
127
125
128
126
# Run ALL the tests, this will likely take a long time
Copy file name to clipboardExpand all lines: docs/index.md
+18-12
Original file line number
Diff line number
Diff line change
@@ -33,31 +33,37 @@ This plugin is included with Lando by default. That means if you have Lando vers
33
33
However if you would like to manually install the plugin, update it to the bleeding edge or install a particular version then use the below. Note that this installation method requires Lando `3.5.0+`.
34
34
35
35
:::: code-group
36
+
::: code-group-item LANDO 3.21+
37
+
```bash:no-line-numbers
38
+
lando plugin-add @lando/mailhog
39
+
```
40
+
:::
41
+
::: code-group-item HYPERDRIVE
42
+
```bash:no-line-numbers
43
+
# @TODO
44
+
# @NOTE: This doesn't actaully work yet
45
+
hyperdrive install @lando/mailhog
46
+
```
47
+
:::
36
48
::: code-group-item DOCKER
37
49
```bash:no-line-numbers
38
50
# Ensure you have a global plugins directory
39
51
mkdir -p ~/.lando/plugins
40
52
41
53
# Install plugin
42
-
# NOTE: Modify the "yarn add @lando/mailhog" line to install a particular version eg
You should be able to verify the plugin is installed by running `lando config --path plugins` and checking for `@lando/mailhog`. This command will also show you _where_ the plugin is being loaded from.
0 commit comments