Init

Author: gent-fella-health

.env.example

@@ -1 +1,2 @@
-BACKEND_URL=http://api-example.com
+VUE_APP_NAME='App Name'
+VUE_APP_BACKEND_URL=http://api-example.com

.gitignore

@@ -2,7 +2,6 @@
 node_modules
 /dist
 
-
 # local env files
 .env
 .env.local

README.md

@@ -1,29 +1,67 @@
-# vue3-starter
+### Installation
 
-## Project setup
-```
+```console
 npm install
-```
-
-### Compiles and hot-reloads for development
-```
+cp .env.example .env
 npm run serve
 ```
 
-### Compiles and minifies for production
-```
-npm run build
-```
+# Vue 3 Starter
 
-### Run your unit tests
-```
-npm run test:unit
-```
+This is a starter project for [Vue Js](https://vuejs.org/).
 
-### Lints and fixes files
-```
-npm run lint
-```
+The project is helpful to start your next project, as it provides a lot of the common tools you may reach for, all ready to go.
+
+### Features
+
+- TypeScript Included.
+- Base pages (like Dashboard/404 etc).
+- Pre-configured with CSS-in-JS styling.
+- Pre-configured with code quality tools: ESLint, Prettier, TypeScript, Jest, etc.
+- Basic tests included.
+- (Admin Kit)[https://github.com/adminkit/adminkit] included.
+
+### Directory Structure
+
+| Name                              | Description |
+| --------------------------------- | ----------- |
+| **build/**                        | Compiled source files will be placed here. |
+| **public/**                       | Static assets (fonts, css, js, img). |
+| **src/**                          | Source files. |
+| **src/components**                | Vue components including shared (common) components. |
+| **src/layouts**                   | Dynamic Layout Components. |
+| **src/modules**                   | Views - screen components. |
+| **src/routes**                    | Application routes. |
+| **src/store**                     | Vuex state management. |
+
+### Requirements
+
+- [Node.js](https://nodejs.org/) v14 or newer.
+
+### Installation
+
+- Clone the repo - `git clone https://github.com/kutia-software-company/vue3-starter`.
+- Install project dependencies — `npm install`.
+- Create `.env` file - `cp .env.example .env`.
+- Launch the app — `npm run dev`, it will become available at [http://localhost:3000](http://localhost:3000/).
+
+### Available Scripts
+
+- `dev`
+- `build`
+- `test:unit`
+- `code:format`
+- `code:check`
+
+### Related Projects
+
+- [Node.js TypeScript API Starter](https://github.com/kutia-software-company/express-typescript-starter).
+- [Node.js TypeScript API Starter](https://github.com/kutia-software-company/react-js-starter).
+
+### License
+
+[MIT](LICENSE).
+
+---
 
-### Customize configuration
-See [Configuration Reference](https://cli.vuejs.org/config/).
+<sup>Made with ♥ by Gentrit Abazi ([@gentritabazi01](https://github.com/gentritabazi01)).</sup>