Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

change readme instructions to run build and run preview #11

Merged
merged 1 commit into from
Oct 17, 2024
Merged

change readme instructions to run build and run preview #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions README.md
View file
Open in desktop
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
View file
Open in desktop

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
View file
Open in desktop
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
View file
Open in desktop
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',
},
},
}
})
Loading