chore: init

PatSosna · Aug 9, 2020 · 76fb084 · 76fb084
commit 76fb084
Show file tree

Hide file tree

Showing 24 changed files with 4,433 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,4 @@
+node_modules
+.DS_Store
+dist
+*.local
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,22 @@
+MIT License
+
+// as this is a project template, free feel to it change to your name.
+Copyright (c) 2020 Anthony Fu 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,56 @@
+<h1 align='center'><samp>Vitesse</samp></h1>
+
+<p align='center'>
+<samp>Opinionated <a href="https://github.com/vitejs/vite">Vite</a> Starter Template</samp>
+</p>
+
+<p align='center'>
+<sup><em>Mocking up web app with <b>⚡️vitesse</b></em></sup>
+</p>
+
+<br>
+
+<p align='center'>
+<a href="https://vitesse.netilfy.app">Live Example</a>
+</p>
+
+<br>
+
+## Pre-packed
+
+### UI Frameworks
+
+- [Tailwind CSS](https://tailwindcss.com/)
+- [tailwindcss-dark-mode](https://github.com/ChanceArthur/tailwindcss-dark-mode)
+- [Iconify](https://iconify.design) - use icons from your favorite sets. [🔍Icônes](https://icones.netlify.app/)
+<!-- - [variantwind](https://github.com/sibbngheid/variantwind) -->
+
+### Router
+
+- [Vue Router](https://github.com/vuejs/vue-router)
+- [Voie](https://github.com/vamplate/vite-plugin-voie) - file based routing
+
+### Utils
+
+- [VueUse](https://github.com/antfu/vueuse)
+
+### Misc
+
+- Use Composition API with [`<script setup>` SFC](https://github.com/vuejs/rfcs/blob/sfc-improvements/active-rfcs/0000-sfc-script-setup.md)
+
+### Dev tools
+
+- [Typescript](https://www.typescriptlang.org/)
+- [pnpm](https://pnpm.js.org/)
+- [Netlify](https://www.netlify.com/)
+- [ESLint](https://eslint.org/) with [@antfu/eslint-config-vue](https://github.com/antfu/eslint-config)
+
+## Use It!
+
+```bash
+git clone https://github.com/antfu/vite-starter && cd vite-starter && rm -rf .git && git init && pnpm i
+```
+
+## Why
+
+I have created several Vite apps recently. Setting the configs up is kinda the bottleneck for me to make the idea simply comes true in very a short time. So I made this starter template for myself to create apps more easily, along with some good practices that I have learned during making those apps. It's strongly opinionated, but feel free to tweak it or even maintains your own forks.
diff --git a/index.html b/index.html
@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <link rel="icon" href="/favicon.svg" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>Vitesse</title>
+  <script src="https://cdn.jsdelivr.net/npm/@iconify/iconify@1.0.7/dist/iconify.min.js"></script>
+</head>
+<body>
+  <div id="app"></div>
+  <script type="module" src="/src/main.ts"></script>
+</body>
+</html>
diff --git a/netlify.toml b/netlify.toml
@@ -0,0 +1,12 @@
+[build.environment]
+  # to disable npm auto install. see https://community.netlify.com/t/using-pnpm-and-pnpm-workspaces/2759
+  NPM_FLAGS="--prefix=/"
+
+[build]
+  publish = "dist"
+  command = "npx pnpm i && npm run build"
+
+[[redirects]]
+  from = "/*"
+  to = "/index.html"
+  status = 200
diff --git a/package.json b/package.json
@@ -0,0 +1,34 @@
+{
+  "name": "@vitesse/template",
+  "version": "0.0.0",
+  "private": true,
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build"
+  },
+  "dependencies": {
+    "@iconify/core": "^1.0.0-beta.3",
+    "@vueuse/core": "^4.0.0-beta.4",
+    "variantwind": "^0.3.4",
+    "vue": "^3.0.0-rc.1",
+    "vue-router": "^4.0.0-beta.6"
+  },
+  "devDependencies": {
+    "@antfu/eslint-config-vue": "^0.2.14",
+    "@typescript-eslint/eslint-plugin": "^3.8.0",
+    "@vue/compiler-sfc": "^3.0.0-rc.5",
+    "eslint": "^7.6.0",
+    "pnpm": "^5.4.12",
+    "tailwindcss": "^1.6.2",
+    "tailwindcss-dark-mode": "^1.1.6",
+    "typescript": "^3.9.7",
+    "vite": "^1.0.0-rc.1",
+    "vite-plugin-voie": "^0.2.0"
+  },
+  "eslintConfig": {
+    "extends": "@antfu/eslint-config-vue",
+    "rules": {
+      "import/no-absolute-path": "off"
+    }
+  }
+}