Skip to content

Commit f02e44a

Browse files
author
Billy Charlton
committed
updated dev page
1 parent 9da9d97 commit f02e44a

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

docs/dev-developing-simwrapper.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ All tooling and source code is entirely free! You can build and hack on SimWrapp
2424
1. Install [the latest "LTS" Version of Node.js](https://nodejs.org/en/)
2525
2. Install [VS Code](https://code.visualstudio.com/)
2626
3. The following VS Code plugins are required. Find them in the VS Code plugin directory.
27+
- **Vue Official**, the official Vue plugin.
2728
- **Prettier** to force code-style consistency
28-
- **Vetur**, the official Vue plugin.
2929

3030
## First time build
3131

@@ -45,9 +45,9 @@ Congrats! You now have SimWrapper installed and you are ready to start hacking!
4545

4646
## Development Commands
4747

48-
**npm run serve** -- Build and run a local copy of the site. This is the main command you will use to start up the dev server, hack on your changes in VS Code, and see the results. `npm run serve` runs a local server with hot reload for testing, which usually listens on http://localhost:8080
48+
**npm run dev** -- Build and run a local copy of the site. This is the main command you will use to start up the dev server, hack on your changes in VS Code, and see the results. `npm run dev` runs a local server with hot reload for testing, which usually listens on http://localhost:5173
4949

50-
**npm run build** -- Compile and minify the build for production. This command builds in "production mode", which performs some optimizations, shakes out unused libraries, and catches some build-time errors. You probably want to run this before you push anything live.
50+
**npm run build** -- Compile and minify the build for production. This command builds in "production mode", which performs some optimizations, shakes out unused libraries, and catches some build-time errors. You want to run this before you push anything live.
5151

5252
**npm run test:unit** -- Run unit tests. Ahahaha well... I have not written tests 👽 but the infrastructure is there to use `jest`.
5353

@@ -74,7 +74,7 @@ We wrote a deploy script that builds and pushes to Github Pages. Follow these in
7474
- `/scripts`: Housekeeping scripts go here. Most of these are used for postprocessing model results, written in Python, and also some build scripts are found here.
7575
- `/src`: all TypeScript and Vue files go here
7676
- `/src/assets`: images, .CSVs, etc that get packaged by the build process go here
77-
- `/src/charts`: Dashboard chart types go here. Each chart type is a separate Vue component.
77+
- `/src/dash-panels`: Dashboard chart types go here. Each chart type is a separate Vue component.
7878
- `/src/components`: shared Vue components go here, there are lots of them
7979
- `/src/js`: some typscript utility classes
8080
- `/src/layers`: shared deck.gl layer files go here. These are generally written in JSX.

0 commit comments

Comments
 (0)