Merge pull request #1 from alkrauss48/switch-to-vite

Switch to vite
alkrauss48 · Jul 27, 2023 · b595942 · b595942
2 parents 481e57a + 588f280
commit b595942
Show file tree

Hide file tree

Showing 32 changed files with 1,735 additions and 11,463 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -3,8 +3,8 @@ name: ci
 on: push
 
 jobs:
-  eslint:
-    name: ESLint
+  lint:
+    name: Lint
     runs-on: ubuntu-latest
     steps:
       - name: Install Node.js
@@ -22,11 +22,11 @@ jobs:
             ${{ runner.os }}-node-
       - name: Install npm dependencies
         run: npm ci --prefer-offline
-      - name: Run ESLint
-        run: npm run lint
+      - name: Run Typescript lint
+        run: node_modules/.bin/vue-tsc
   build:
     name: Build
-    needs: ['eslint']
+    needs: ['lint']
     runs-on: ubuntu-latest
     steps:
       -

diff --git a/.gitignore b/.gitignore
@@ -1,21 +1,22 @@
-.DS_Store
-node_modules
-/dist
-
-
-# local env files
-.env.local
-.env.*.local
-
-# Log files
+# Logs
+logs
+*.log
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
 
 # Editor directories and files
+.vscode/*
+!.vscode/extensions.json
 .idea
-.vscode
+.DS_Store
 *.suo
 *.ntvs*
 *.njsproj

diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -0,0 +1,3 @@
+{
+  "recommendations": ["Vue.volar", "Vue.vscode-typescript-vue-plugin"]
+}
diff --git a/README.md b/README.md
@@ -1,24 +1,43 @@
-# simple-slides
+# Simple Slides
 
-## Project setup
+[Simple Slides](https://simpleslides.dev) is a small Vue app built with Vite and
+TypeScript that allows for simple and content-friendly rendering of presentation
+slides via Markdown.
+
+Simple Slides follows the [Takahashi Method]() of presenting slides, which
+focuses on:
+
+* Prioritizing text-content
+* Low amount of content per slide
+* Many slides, and changing through slides quickly
+
+## To Install
 ```
 npm install
 ```
 
-### Compiles and hot-reloads for development
-```
-npm run serve
+## To Run
 ```
+npm run dev # Navigate to http://localhost:5173
 
-### Compiles and minifies for production
-```
-npm run build
-```
+# Alternatively, you can run with Docker,
+# but that will generate a release build,
+# which is not ideal for developing
 
-### Lints and fixes files
-```
-npm run lint
+docker compose up
 ```
 
-### Customize configuration
-See [Configuration Reference](https://cli.vuejs.org/config/).
+## Recommended IDE Setup
+
+- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
+
+## Type Support For `.vue` Imports in TS
+
+TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
+
+If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
+
+1. Disable the built-in TypeScript Extension
+   1. Run `Extensions: Show Built-in Extensions` from VSCode's command palette
+   2. Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
+2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
diff --git a/babel.config.js b/babel.config.js
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -8,4 +8,4 @@ services:
       context: .
       dockerfile: docker/frontend/Dockerfile
     ports:
-      - "8080:80"
+      - "5173:80"
diff --git a/docker/frontend/Dockerfile b/docker/frontend/Dockerfile
@@ -6,7 +6,7 @@ COPY package.json package-lock.json ./
 RUN npm ci
 
 COPY . .
-RUN node_modules/.bin/vue-cli-service build
+RUN node_modules/.bin/vite build
 
 # Final Image
 FROM nginx:stable-alpine

diff --git a/public/index.html → index.html b/public/index.html → index.html
@@ -32,10 +32,7 @@
     <meta name="twitter:creator" content="@thecodeboss">
   </head>
   <body class="m-0">
-    <noscript>
-      <strong>We're sorry but <%= htmlWebpackPlugin.options.title %> doesn't work properly without JavaScript enabled. Please enable it to continue.</strong>
-    </noscript>
     <div id="app"></div>
-    <!-- built files will be auto injected -->
+    <script type="module" src="/src/main.ts"></script>
   </body>
 </html>
diff --git a/jsconfig.json b/jsconfig.json