Remove vite-plugin-static-copy

Also update README with updated instructions
Coteh · May 24, 2024 · 8168f92 · 8168f92
1 parent a5b352f
commit 8168f92
Show file tree

Hide file tree

Showing 30 changed files with 31 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -16,28 +16,39 @@ Simple clone of the well-known Minesweeper game. Created using JavaScript, Node.
 ![In-Game](screenshots/game.png "In-Game")
 
 ## Installation
-To run the game locally, simply run the following to install dependencies:
-```
-npm install
-```
+To run the game locally, follow these steps:
 
-Then run the following to build the game:
-```
-npm run build
-```
+1. **Install Dependencies**
 
-You can then run a local server on the `build` directory and open it on your browser to play. eg:
+   Run the following command to install the necessary dependencies:
+   ```sh
+   npm install
+   ```
 
-```
-python -m http.server 8000 -d build
+2. **Build the Game**
 
-# then open http://localhost:8000 to play locally
-```
+    Use the following command to build the game:
+    ```sh
+    npm run build
+    ```
 
-You can also run the following to run the game in development mode:
-```
-npm run dev
-```
+3. **Serve the Game Locally**
+
+    Run a local server to serve the contents of the build directory and open the game in your browser:
+    ```sh
+    npm run serve
+    ```
+
+    Then open http://localhost:4173 to play the game locally.
+
+4. **Development Mode**
+
+    To run the game in development mode, use the following command:
+    ```sh
+    npm run dev
+    ```
+
+    Then open http://localhost:5173 to play the game locally in development mode. The game will reload on changes in the source.
 
 ## Issues
 - Unit and Integration testing is limited

diff --git a/index.html b/index.html
@@ -3,7 +3,7 @@
     <head>
         <title>MinesweeperClone</title>
         <meta charset="utf-8" />
-        <link rel="stylesheet" href="style.css" />
+        <link rel="stylesheet" href="/style.css" />
     </head>
     <body>
         <div id="content" class="container"></div>

diff --git a/package.json b/package.json
@@ -8,6 +8,7 @@
   "scripts": {
     "dev": "vite serve",
     "build": "vite build",
+    "serve": "vite preview",
     "format": "prettier --config ./.prettierrc --write .",
     "test": "node --experimental-vm-modules node_modules/jest-cli/bin/jest.js"
   },
@@ -20,8 +21,7 @@
   "dependencies": {
     "pixi.js": "4.3.0",
     "vite": "^5.2.11",
-    "vite-plugin-node-polyfills": "^0.22.0",
-    "vite-plugin-static-copy": "^1.0.5"
+    "vite-plugin-node-polyfills": "^0.22.0"
   },
   "devDependencies": {
     "jest-cli": "^29.7.0",

diff --git a/img/Block.png → public/img/Block.png b/img/Block.png → public/img/Block.png
diff --git a/img/Block_held.png → public/img/Block_held.png b/img/Block_held.png → public/img/Block_held.png
diff --git a/img/Block_highlighted.png → public/img/Block_highlighted.png b/img/Block_highlighted.png → public/img/Block_highlighted.png
diff --git a/img/Block_selected.png → public/img/Block_selected.png b/img/Block_selected.png → public/img/Block_selected.png
diff --git a/img/Button.png → public/img/Button.png b/img/Button.png → public/img/Button.png
diff --git a/img/Checkbox_checked.png → public/img/Checkbox_checked.png b/img/Checkbox_checked.png → public/img/Checkbox_checked.png
diff --git a/img/Checkbox_unchecked.png → public/img/Checkbox_unchecked.png b/img/Checkbox_unchecked.png → public/img/Checkbox_unchecked.png
diff --git a/img/Flag.png → public/img/Flag.png b/img/Flag.png → public/img/Flag.png
diff --git a/img/Logo.png → public/img/Logo.png b/img/Logo.png → public/img/Logo.png
diff --git a/img/Mine.png → public/img/Mine.png b/img/Mine.png → public/img/Mine.png
diff --git a/img/Smiley.png → public/img/Smiley.png b/img/Smiley.png → public/img/Smiley.png
diff --git a/img/Smiley_proud.png → public/img/Smiley_proud.png b/img/Smiley_proud.png → public/img/Smiley_proud.png
diff --git a/img/Smiley_sad.png → public/img/Smiley_sad.png b/img/Smiley_sad.png → public/img/Smiley_sad.png
diff --git a/img/Star.png → public/img/Star.png b/img/Star.png → public/img/Star.png
diff --git a/img/Tiles.png → public/img/Tiles.png b/img/Tiles.png → public/img/Tiles.png
diff --git a/img/digits/0.png → public/img/digits/0.png b/img/digits/0.png → public/img/digits/0.png
diff --git a/img/digits/1.png → public/img/digits/1.png b/img/digits/1.png → public/img/digits/1.png
diff --git a/img/digits/2.png → public/img/digits/2.png b/img/digits/2.png → public/img/digits/2.png
diff --git a/img/digits/3.png → public/img/digits/3.png b/img/digits/3.png → public/img/digits/3.png
diff --git a/img/digits/4.png → public/img/digits/4.png b/img/digits/4.png → public/img/digits/4.png
diff --git a/img/digits/5.png → public/img/digits/5.png b/img/digits/5.png → public/img/digits/5.png
diff --git a/img/digits/6.png → public/img/digits/6.png b/img/digits/6.png → public/img/digits/6.png
diff --git a/img/digits/7.png → public/img/digits/7.png b/img/digits/7.png → public/img/digits/7.png
diff --git a/img/digits/8.png → public/img/digits/8.png b/img/digits/8.png → public/img/digits/8.png
diff --git a/img/digits/9.png → public/img/digits/9.png b/img/digits/9.png → public/img/digits/9.png
diff --git a/style.css → public/style.css b/style.css → public/style.css
diff --git a/vite.config.js b/vite.config.js
@@ -1,7 +1,6 @@
 import { defineConfig } from 'vite';
 import path from "path";
 import { version } from './package.json';
-import { viteStaticCopy } from 'vite-plugin-static-copy';
 import { nodePolyfills } from 'vite-plugin-node-polyfills';
 
 export default defineConfig({
@@ -20,13 +19,6 @@ export default defineConfig({
         }
     },
     plugins: [
-        // TODO: "Before you use this plugin, consider using public directory or import in JavaScript. In most cases, these will work."
-        viteStaticCopy({
-            targets: [
-                { src: 'img/', dest: '.' },
-                { src: 'style.css', dest: '.' },
-            ]
-        }),
         nodePolyfills(),
     ]
 })