Add installation manual

andriichuk · andriichuk · commit 095d0c70c82c · 2021-01-10T21:55:10.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -2,6 +2,9 @@
 /node_modules
 /public/hot
 /public/storage
+/public/mix-manifest.json
+/public/images
+/public/js
 /storage/*.key
 /vendor
 .env
diff --git a/README.md b/README.md
@@ -1,3 +1,51 @@
-### Laravel VueJS Starter Kit
+## Laravel VueJS Starter Kit
 
-Coming soon...
+Features
+
+* [Laravel 8.x](https://laravel.com/docs/8.x/installation)
+    * [Sail (PHP 7.4)](https://laravel.com/docs/8.x/sail)
+* [VueJS 2.x](https://vuejs.org/v2/guide/)
+    * [Vuex](https://vuex.vuejs.org/)
+    * [Vue Router](https://router.vuejs.org/)
+
+### Installation
+
+Clone this repository
+
+```shell
+git clone git@github.com:andriichuk/laravel-vue-js-starter-kit.git
+```
+
+Up Docker containers for the first time
+
+```shell
+composer install
+
+./vendor/bin/sail up
+```
+
+Install composer dependencies in the next time
+
+```shell
+./vendor/bin/sail composer install
+```
+
+Fill in environment variables
+
+```shell
+cp .env.example .env
+```
+
+Install and run `npm` watch task
+
+```shell
+./vendor/bin/sail npm install && npm run watch
+```
+
+Update `hosts` file
+
+```text
+127.0.0.1 laravel.test
+```
+
+Open [laravel.test](http:://laravel.test) in the browser
diff --git a/public/mix-manifest.json b/public/mix-manifest.json
diff --git a/resources/views/app.blade.php b/resources/views/app.blade.php
@@ -0,0 +1,27 @@
+<!doctype html>
+<html lang="{{ str_replace('_', '-', app()->getLocale()) }}">
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+
+    <!-- CSRF Token -->
+    <meta name="csrf-token" content="{{ csrf_token() }}">
+
+    <title>{{ config('app.name', 'Laravel') }}</title>
+
+    <!-- Fonts -->
+    <link rel="dns-prefetch" href="//fonts.gstatic.com">
+    <link href="https://fonts.googleapis.com/css?family=Nunito" rel="stylesheet">
+
+    <!-- Styles -->
+    <link href="{{ asset('css/app.css') }}" rel="stylesheet">
+</head>
+<body>
+    <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>
+    <script src="{{ mix('/js/main.js') }}"></script>
+</body>
+</html>
+
diff --git a/resources/views/layouts/app.blade.php b/resources/views/layouts/app.blade.php
diff --git a/routes/web.php b/routes/web.php
@@ -13,6 +13,4 @@
 |
 */
 
-Route::get('/', function () {
-    return view('layouts.app');
-});
+Route::view('/', 'app');

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,4 @@`
`13`	`13`	`\|`
`14`	`14`	`*/`
`15`	`15`
`16`		`-Route::get('/', function () {`
`17`		`- return view('layouts.app');`
`18`		`-});`
	`16`	`+Route::view('/', 'app');`