Skip to content

Commit

Permalink
change readme instructions to run build and run preview
Browse files Browse the repository at this point in the history
(10)
  • Loading branch information
Pewillia committed Sep 24, 2024
1 parent 21374e8 commit 1e000fb
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 9 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,19 @@ The tech stack for this application includes the following frameworks or technol

## Running The Project

First thing; we encourage you to folk the repo instead of cloning it - especially if you would like to contribute to it.
First thing; we encourage you to fork the repo instead of cloning it - especially if you would like to contribute to it.
If not; you can do ahead and clone it.

### Cloning the repo

```git clone https://github.com/Canadian-Geospatial-Platform/geoview-demo.git```

### Install the packages
``` npm run install```

``` npm install```
### build the dist directory
``` npm run build```
### Run the application
```npm run serve```
```npm run dev```

### Deploying to GitHub Pages
```npm run deploy```
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 4 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@
"type": "module",
"scripts": {
"dev": "vite",
"build": "tsc -b && vite build",
"build": "tsc -b && vite build --watch --config vite.config.ts",
"lint": "eslint .",
"preview": "vite preview",
"dev": "vite dev",
"predeploy": "npm run build",
"deploy": "gh-pages -d dist"
"deploy": "gh-pages -d dist",
"start": "react-scripts start"
},
"dependencies": {
"@emotion/react": "^11.13.0",
Expand Down
8 changes: 7 additions & 1 deletion vite.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,15 @@ import react from '@vitejs/plugin-react';
export default defineConfig({
plugins: [react()],
base: "/geoview-demo/",

resolve: {
alias: {
'@': '/src',
},
},
},
build: {
watch: {
// https://rollupjs.org/configuration-options/#watch
},
}
})

0 comments on commit 1e000fb

Please sign in to comment.