Skip to content

Commit 89a5971

Browse files
authored
Update README.dev.md
1 parent b251b3c commit 89a5971

1 file changed

Lines changed: 14 additions & 19 deletions

File tree

README.dev.md

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,48 +4,43 @@ If you are looking for user documentation, go [here](README.md).
44

55
## Prerequisites
66

7-
- Relevant issues:
8-
- ...
9-
- Hardware requirements
10-
117
- [npm CLI](https://docs.npmjs.com/cli/v7): Package manager command line interface shipped with NodeJS.
128

13-
149
## Code editor
1510

16-
1. Do we need an editor plugin?
17-
1. How to see it in your editor
18-
19-
### Virtual environments
11+
- VSCode extensions: https://code.visualstudio.com/
12+
- https://marketplace.visualstudio.com/items?itemName=Vue.volar
13+
- https://marketplace.visualstudio.com/items?itemName=octref.vetur
14+
- https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint
15+
- WebStorm: https://www.jetbrains.com/webstorm/
16+
- Atom: https://atom.io/
17+
- Vim
2018

21-
1. What different flavors of dependencies are there?
22-
1. Creating and deleting a virtual environment
23-
1. How to install dependencies, e.g. runtime, development, publishing
24-
1. How to clear caches
25-
1. See what's installed
19+
## Virtual environments
2620

27-
### Build and runtime dependencies
21+
[nvm](https://github.com/nvm-sh/nvm) or (nvs)[https://github.com/jasongin/nvs] can be used to manage node versions.
2822

29-
1. Versions of these tools
23+
## Installing the dependencies
3024

3125
The command below will install npm dependencies
3226

3327
```shell
3428
npm clean-install
3529
```
3630

31+
## Starting the development server
3732

38-
## start the development server
33+
You can start the development server by running
3934

4035
```shell
4136
npm run dev
4237
```
4338

4439
Use a browser to navigate to [localhost:8080](http://localhost:8080/) to see the website.
4540

46-
## build the application
41+
## Building the application
4742

48-
The command below will build the application and save the output in `docs/` folder.
43+
The command below will build the application and save the output in `docs/` folder. This is what we serve in the demo page.
4944

5045
```shell
5146
npm run build

0 commit comments

Comments
 (0)