Merge pull request #12 from obewds/dev

0.1.10 - refining project naming conventions and adding npm dep install and vscode extension scripting

.vscode/settings.json

@@ -1,14 +1,29 @@
 {
     "cSpell.words": [
         "apdisk",
+        "autoimport",
+        "bmewburn",
+        "bradlc",
+        "dbaeumer",
         "donotpresent",
         "ehthumbs",
         "encryptable",
         "esktop",
+        "formulahendry",
         "fseventsd",
+        "gruntfuggly",
         "icns",
+        "intelephense",
+        "janne",
+        "kohler",
+        "mikestead",
         "msix",
+        "onecentlin",
+        "petermekhaeil",
+        "ryannaddy",
+        "sibiraj",
         "stackdump",
+        "steoates",
         "timemachine"
     ]
 }

README.md

@@ -1,2 +1,59 @@
 # The VILT Design System
 The official repository for the VILT Design System for the Vue.js, Inertia.js, Laravel, and Tailwind CSS web app stack that is turbocharged with Typescript and VueVentus.
+
+
+## Installation Prep
+
+Create a new project repo (IE GitHub), and/or use a tool like GitHub Desktop to clone your repo locally to give your new project a root directory and corresponding versioning repository.
+
+```bash
+curl -s https://laravel.build/new-app-name-here | bash
+```
+
+Move ALL the installed files into repo root directory and out of the installed directory (IE the `new-app-name-here` directory in this example).
+
+```bash
+composer require laravel/jetstream
+```
+
+> It's highly advised to use Laravel Sail and Docker Desktop to make installation easier for both beginners and experts alike. This guid assumes your local dev machine has Docker Desktop installed as well as a Laravel Sail shortcut to remove the need to precede sail CLI commands from needing a `php` prefix!
+
+> It's also highly advised to use Inertia's SSR feature as it makes for more resilient Vue component code and functionality as a project evolves into a bigger project!
+
+```bash
+# to start and use Laravel Sail run:
+sail up
+# then in a separate console run:
+sail artisan jetstream:install inertia --dark --ssr
+# or this to add Jetstream teams:
+sail artisan jetstream:install inertia --dark --ssr --teams
+```
+
+And lastly in a new console if necessary, the following command will create the app's initial local database tables:
+
+```bash
+sail artisan migrate
+```
+
+Next up, you can check out the install so far using (vite will give you a link from the console to your localhost'ed Laravel/Jetstream app so far!):
+
+```bash
+npm run dev
+```
+
+
+## Installing VILT DS
+
+And now you can finally install VILT DS with the following command:
+
+```bash
+npm install -D @obewds/vilt-ds
+```
+
+Once the VILT DS package is installed, and Laravel/Jetstream are installed, you can access and run the VILT DS installation CLI with:
+
+```bash
+npx vilt-ds
+```
+
+

dist/data/ide/viltDsVsCodeExtensions.d.ts

@@ -0,0 +1,6 @@
+export type ViltDsVsCodeExtension = 'vue.volar' | 'vue.vscode-typescript-vue-plugin' | 'bmewburn.vscode-intelephense-client' | 'bradlc.vscode-tailwindcss' | 'christian-kohler.npm-intellisense' | 'dbaeumer.vscode-eslint' | 'esbenp.prettier-vscode' | 'formulahendry.auto-close-tag' | 'formulahendry.auto-rename-tag' | 'gruntfuggly.todo-tree' | 'janne252.fontawesome-autocomplete' | 'mikestead.dotenv' | 'ms-vscode-remote.remote-containers' | 'onecentlin.laravel-extension-pack' | 'petermekhaeil.vscode-tailwindcss-explorer' | 'redhat.vscode-yaml' | 'shd101wyy.markdown-preview-enhanced' | 'sibiraj-s.vscode-scss-formatter' | 'steoates.autoimport' | 'streetsidesoftware.code-spell-checker';
+export interface ViltDsVsCodeExtensions {
+    recommendations: Array<ViltDsVsCodeExtension>;
+}
+declare let viltDsVsCodeExtensions: ViltDsVsCodeExtensions;
+export default viltDsVsCodeExtensions;

dist/data/npm/viltDsJetstreamDeps.d.ts

@@ -0,0 +1,3 @@
+export type ViltDsJetstreamDependency = 'typescript' | '@types/node' | '@inertiajs/progress' | '@types/ziggy-js' | 'ziggy-js' | '@obewds/vueventus' | '@headlessui/vue' | '@tailwindcss/aspect-ratio' | '@headlessui/tailwindcss' | 'tailwind-scrollbar' | '@types/gsap' | 'gsap';
+declare const _default: ViltDsJetstreamDependency[];
+export default _default;

dist/helpers/run.d.ts

@@ -0,0 +1 @@
+export default function (installString: string): void;