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 Oct 11, 2024
1 parent 105d5ad commit af6d5ce
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 12 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@
This application is a demo application for using the geoview map.
It also includes the following;
1. Config Builder - This helps users build configuration files and test them via UI. Users can also start with existing configurations.
2. API Functions - This part of the application demonstrates how differents API functions work and how to use them. It provides code snippets of to invoke our API functions.
2. API Functions - This part of the application demonstrates how different API functions work and how to use them. It provides code snippets of how to invoke our API functions.

## [Demo](https://canadian-geospatial-platform.github.io/geoview-demo/)

## STRUCTURE / ARCHITECT
The tech stack for this application includes the following frameworks or technologies;
Expand All @@ -16,18 +17,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.
If not; you can do ahead and clone 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 go 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.

5 changes: 2 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,10 @@
"version": "0.0.0",
"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",
"predeploy": "npm run build",
"dev": "vite dev",
"deploy": "gh-pages -d dist"
},
"dependencies": {
Expand Down
3 changes: 2 additions & 1 deletion vite.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,10 @@ import react from '@vitejs/plugin-react';
export default defineConfig({
plugins: [react()],
base: "/geoview-demo/",

resolve: {
alias: {
'@': '/src',
},
},
}
})

0 comments on commit af6d5ce

Please sign in to comment.