From af6d5cee7b92be35c98078bfb86e78024494d67b Mon Sep 17 00:00:00 2001 From: pewillia Date: Wed, 18 Sep 2024 10:59:56 -0400 Subject: [PATCH] change readme instructions to run build and run preview (10) --- README.md | 14 ++++++++------ package-lock.json | 4 ++-- package.json | 5 ++--- vite.config.ts | 3 ++- 4 files changed, 14 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index a07e6fd..b8e44bd 100644 --- a/README.md +++ b/README.md @@ -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; @@ -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``` diff --git a/package-lock.json b/package-lock.json index f2dabf2..8ae1f90 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,11 +1,11 @@ { - "name": "my-vue-app", + "name": "geoview-demo", "version": "0.0.0", "lockfileVersion": 3, "requires": true, "packages": { "": { - "name": "my-vue-app", + "name": "geoview-demo", "version": "0.0.0", "dependencies": { "@emotion/react": "^11.13.0", diff --git a/package.json b/package.json index 2bcfc60..c978d20 100644 --- a/package.json +++ b/package.json @@ -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": { diff --git a/vite.config.ts b/vite.config.ts index 2038299..eea6db6 100644 --- a/vite.config.ts +++ b/vite.config.ts @@ -5,9 +5,10 @@ import react from '@vitejs/plugin-react'; export default defineConfig({ plugins: [react()], base: "/geoview-demo/", + resolve: { alias: { '@': '/src', }, -}, + } })