Create a Laravel Vue Single Page App in Under an Hour

Laravel Vue single-page app is becoming the most popular choice for developing PHP projects. One important reason for this popularity is Vue JS. Vue gives an expressive API for building strong JavaScript applications utilizing components. As with CSS, we may utilize Laravel Blend to effectively compile JavaScript components into a single, browser-ready JavaScript file.

The combination of Laravel Vue JS results in fast, secure, and impressive applications that need minimum time to go from ideation to final code review. The support for Vue.js means that Laravel developers could use Vue components easily within their apps without wasting time in writing integrations for the components. To demonstrate the support, I decided to create a single-page app in Laravel with a Vue.js-powered frontend.

Why You Should Use Vue with Laravel

VueJS is simple and less opinionated than other frameworks. It has a CLI project generator which makes it easy to build a project prototype having a temporary structure. Its CLI executes an upgradeable runtime dependency which can be extended using a plugin.

Vue offers a variety of default options for different tasks and also provides a pre-established conventional environment for building enterprise-level applications. The framework’s syntax is completely harnessed from the JavaScript expression.

Nowadays, there is a big fuss over why we should use VueJS with Laravel. The question that needs to be asked is what does Vue have to offer and how will it comply with our functional needs?

Here are some of the important features that make VueJS a pretty handy tool to use with Laravel:

Front-end is Everything

Today, the whole internet is event-driven, and these events are being updated on the screen displayed to the user. So, for the user to be up-to-date, there is no need to refresh their page again and again, thanks to JavaScript.

Reactiveness of Vue

A highly interactive frontend can be built using VueJS, in which the display of the user is event-driven and all the activity around him is updated quickly. The framework provides an amazing experience for the users, as it can trigger UI changes dynamically and can couple them very nicely with Laravel.

Single Page WebApp

In remote countries where accessing the internet sometimes becomes difficult, a single page application gives ease to load the URL if it is cached earlier. It allows users to access the application multiple times, as it is saved earlier in the caches requiring less time to load in the browser.

Easy to Use

Vue is really easy to get started with as it works with simple concept of JavaScript. It allows you to build non-trivial applications within minutes, as it is pretty straightforward and easy to understand. Moreover, if your template is built on HTML, it automatically becomes valid for VueJS as it requires no additional scripting to change the existing structure. 

Prerequisites

For the purpose of this Laravel Vue JS tutorial, I assume that you have a Laravel application installed on a web server.

Install Node.js with NPM

The first step is the installation of Node.js with NPM.

For this first install Node.js. Next go to the project’s folder and type the following command in the terminal:

1. npm init
2. npm install

This command will install all the JavaScript dependencies for VueJS. In addition, the command will also install laravel-mix, an API for defining webpack.

Configure the Database

Now setup the MySQL database and configure it in Laravel.

In the project root, you will find the .env and config/database.php files. Add the database credentials (username, DB name, and password) to setup the database and allow the Laravel Single page app to access it.

Create the Migrations

In the third step, open the terminal and go to the root of the newly created Laravel project and generate a new migration to create task table:

1. cd /path-to-project/project-name
3. php artisan make:migration create_tasks_table --create=tasks

Next , open the migration file located in the database/migration2 folder and replace the up() function with the following code:

1. public function up()
3. {
5. Schema::create('tasks', function (Blueprint $table) {
7. $table->increments('id');
9. $table->string('name');
11. $table->unsignedInteger('user_id');
13. $table->text('description');
15. $table->timestamps();
17. });
19. }

Next , In the app/Providers/AppServiceProvider.php file, the boot method sets a default string length:

1. use Illuminate\Support\Facades\Schema;
3. public function boot()
7. {
9. Schema::defaultStringLength(191);
11. }

Run the Migration

Create the tables in the database by using the following command:

1. Php artisan migrate

Setup User Authentication

Laravel provide default user authentication in which you can register users who can then login through the provided login system. This login system also provides Laravel CRSF authentication token to further strengthen the security of the application against malicious exploits. Use the following command to set up user authentication in the Laravel Vue SPA:

1. php artisan make:auth

Create Task Model and Task Controller

Create task model because I will handle database operations through Laravel Eloquent. I also need a controller to handle user requests such as create, read, update and delete operations.

Use the following command to create the model and the controller:

1. php artisan make:model Task -r

Next open the Task Model which in app/Task.php and controller at /app/Http/Controllers/TaskController.php. Update the model code with the following code.

1. <?php
5. namespace App;
9. use Illuminate\Database\Eloquent\Model;
11. use Illuminate\Contracts\Validation\Validator;
13. class Task extends Model
15. {
17. protected $fillable = [
19. 'name',
21. 'user_id',
23. 'description',
25. ];
27. }

The Code for Controller

Next, update the controller file with the following code.

1. <?php
3. namespace App\Http\Controllers;
5. use App\Task;
7. use Illuminate\Http\Request;
9. use Illuminate\Support\Facades\Auth;
13. class TaskController extends Controller
15. {
17. /**
19. * Display a listing of the resource.
21. *
23. * @return \Illuminate\Http\Response
25. */
29. public function index()
31. {
35. $tasks = Task::where(['user_id' => Auth::user()->id])->get();
37. return response()->json([
39. 'tasks' => $tasks,
41. ], 200);
43. }
47. /**
49. * Show the form for creating a new resource.
51. *
53. * @return \Illuminate\Http\Response
55. */
57. public function create()
59. {
61. //
63. }
67. /**
69. * Store a newly created resource in storage.
71. *
73. * @param \Illuminate\Http\Request $request
75. * @return \Illuminate\Http\Response
77. */
79. public function store(Request $request)
81. {
83. }
87. /**
89. * Display the specified resource.
91. *
93. * @param \App\Task $task
95. * @return \Illuminate\Http\Response
97. */
99. public function show(Task $task)
101. {
103. //
105. }
109. /**
111. * Show the form for editing the specified resource.
113. *
115. * @param \App\Task $task
117. * @return \Illuminate\Http\Response
119. */
121. public function edit(Task $task)
123. {
125. //
127. }
131. /**
133. * Update the specified resource in storage.
135. *
137. * @param \Illuminate\Http\Request $request
139. * @param \App\Task $task
141. * @return \Illuminate\Http\Response
143. */
145. public function update(Request $request, Task $task)
147. {
149. }
153. /**
155. * Remove the specified resource from storage.
157. *
159. * @param \App\Task $task
161. * @return \Illuminate\Http\Response
163. */
165. public function destroy(Task $task)
167. {
169. }
171. }

Middleware

To setup middleware for Laravel SPA, add the following code to the Task Controller.

1. public function __construct()
3. {
5. $this->middleware('auth');
7. }

Create the Method

In the store() method of Task Controller, update the following code to add data into database.

1. $this->validate($request, [
3. 'name' => 'required',
5. 'description' => 'required',
7. ]);
9. $task = Task::create([
11. 'name' => request('name'),
13. 'description' => request('description'),
15. 'user_id' => Auth::user()->id
17. ]);
23. return response()->json([
25. 'task' => $task,
27. 'message' => 'Success'
29. ], 200);

Update Method

In Update() method of Task Controller, update the following code to edit database data. database.

1. $this->validate($request, [
3. 'name' => 'required|max:255',
5. 'description' => 'required',
7. ]);
9. $task->name = request('name');
11. $task->description = request('description');
13. $task->save();
15. return response()->json([
17. 'message' => 'Task updated successfully!'
19. ], 200);

Delete Method

In the Destroy() method of Task Controller,  the following code will delete data from the database.

1. $task->delete();
3. return response()->json([
5. 'message' => 'Task deleted successfully!'
7. ], 200);

Route Set up in Laravel SPA

Route sets the application URL and the controller method for the URL. Routes are located in route/web.php and contains the following code:

1. Route::get('/home', 'HomeController@index')->name('home');
3. Route::resource('/task', 'TaskController');

Create Vue.js Components

Create a new file for Task component inside /resources/assets/js/components/ folder named Task.vue and add following sample code:

1. Task.vue:
3. <template>
5. <div class="container">
7. <div class="row">
9. <div class="col-md-12">
11. <div class="panel panel-default">
13. <div class="panel-heading">My Assigments</div>
17. <div class="panel-body">
21. </div>
23. </div>
25. </div>
27. </div>
29. </div>
31. </template>
35. <script>
37. export default {
39. mounted() {
43. }
45. }
47. </script>

The component is ready for registration. Open app.js file from /resources/assets/js/app.js and add the following line after example component registration line:

1. app.js:
3. Vue.component('task', require('./components/Task.vue'));

Compile Assets

Use the following command to compile the newly added code as a Vue.js component. This will also register component:

1. npm run dev

Calling in the View

Now open home.blade.php located in /resources/views/ and update it as follows:

1. @extends('layouts.app')
3. @section('content')
5. <task></task>
7. @endsection

Create Update & Delete in Task.vue

The Task component is located inside /resources/assets/js/components/ and is named Task.vue. Open this file and update the code:

1. <template>
3. <div class="container">
5. <div class="row">
7. <div class="col-md-12">
9. <div class="panel panel-default">
11. <div class="panel-heading">
13. <h3><span class="glyphicon glyphicon-dashboard"></span> Assignment Dashboard </h3> <br>
14. <button @click="initAddTask()" class="btn btn-success " style="padding:5px">
15. Add New Assignment
16. </button>
18. </div>
22. <div class="panel-body">
24. <table class="table table-bordered table-striped table-responsive" v-if="tasks.length > 0">
26. <tbody>
28. <tr>
30. <th>
32. No.
34. </th>
36. <th>
38. Name
40. </th>
42. <th>
44. Description
46. </th>
48. <th>
50. Action
52. </th>
54. </tr>
56. <tr v-for="(task, index) in tasks">
58. <td>{{ index + 1 }}</td>
60. <td>
62. {{ task.name }}
64. </td>
66. <td>
68. {{ task.description }}
70. </td>
72. <td>
73. <button @click="initUpdate(index)" class="btn btn-success btn-xs" style="padding:8px"><span class="glyphicon glyphicon-edit"></span></button>
75. <button @click="deleteTask(index)" class="btn btn-danger btn-xs" style="padding:8px"><span class="glyphicon glyphicon-trash"></span></button>
77. </td>
79. </tr>
81. </tbody>
83. </table>
85. </div>
87. </div>
89. </div>
91. </div>
95. <div class="modal fade" tabindex="-1" role="dialog" id="add_task_model">
97. <div class="modal-dialog" role="document">
99. <div class="modal-content">
101. <div class="modal-header">
103. <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span
105. aria-hidden="true">&times;</span></button>
107. <h4 class="modal-title">Add New Task</h4>
109. </div>
111. <div class="modal-body">
115. <div class="alert alert-danger" v-if="errors.length > 0">
117. <ul>
119. <li v-for="error in errors">{{ error }}</li>
121. </ul>
123. </div>
127. <div class="form-group">
129. <label for="names">Name:</label>
131. <input type="text" name="name" id="name" placeholder="Task Name" class="form-control"
133. v-model="task.name">
135. </div>
137. <div class="form-group">
139. <label for="description">Description:</label>
141. <textarea name="description" id="description" cols="30" rows="5" class="form-control"
143. placeholder="Task Description" v-model="task.description"></textarea>
145. </div>
147. </div>
149. <div class="modal-footer">
151. <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
153. <button type="button" @click="createTask" class="btn btn-primary">Submit</button>
155. </div>
157. </div><!-- /.modal-content -->
159. </div><!-- /.modal-dialog -->
161. </div><!-- /.modal -->
165. <div class="modal fade" tabindex="-1" role="dialog" id="update_task_model">
167. <div class="modal-dialog" role="document">
169. <div class="modal-content">
171. <div class="modal-header">
173. <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span
175. aria-hidden="true">&times;</span></button>
177. <h4 class="modal-title">Update Task</h4>
179. </div>
181. <div class="modal-body">
185. <div class="alert alert-danger" v-if="errors.length > 0">
187. <ul>
189. <li v-for="error in errors">{{ error }}</li>
191. </ul>
193. </div>
197. <div class="form-group">
199. <label>Name:</label>
201. <input type="text" placeholder="Task Name" class="form-control"
203. v-model="update_task.name">
205. </div>
207. <div class="form-group">
209. <label for="description">Description:</label>
211. <textarea cols="30" rows="5" class="form-control"
213. placeholder="Task Description" v-model="update_task.description"></textarea>
215. </div>
217. </div>
219. <div class="modal-footer">
221. <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
223. <button type="button" @click="updateTask" class="btn btn-primary">Submit</button>
225. </div>
227. </div><!-- /.modal-content -->
229. </div><!-- /.modal-dialog -->
231. </div><!-- /.modal -->
235. </div>
237. </template>
241. <script>
243. export default {
245. data(){
247. return {
249. task: {
251. name: '',
253. description: ''
255. },
257. errors: [],
259. tasks: [],
261. update_task: {}
263. }
265. },
267. mounted()
269. {
271. this.readTasks();
273. },
275. methods: {
279. deleteTask(index)
281. {
283. let conf = confirm("Do you ready want to delete this task?");
285. if (conf === true) {
289. axios.delete('/task/' + this.tasks[index].id)
291. .then(response => {
295. this.tasks.splice(index, 1);
299. })
301. .catch(error => {
305. });
307. }
309. },
311. initAddTask()
313. {
315. $("#add_task_model").modal("show");
317. },
319. createTask()
321. {
323. axios.post('/task', {
325. name: this.task.name,
327. description: this.task.description,
329. })
331. .then(response => {
335. this.reset();
339. this.tasks.push(response.data.task);
343. $("#add_task_model").modal("hide");
347. })
349. .catch(error => {
351. this.errors = [];
355. if (error.response.data.errors && error.response.data.errors.name) {
357. this.errors.push(error.response.data.errors.name[0]);
359. }
361. if (error.response.data.errors && error.response.data.errors.description)
363. {
365. this.errors.push(error.response.data.errors.description[0]);
367. }
369. });
371. },
373. reset()
375. {
377. this.task.name = '';
379. this.task.description = '';
381. },
383. readTasks()
385. {
387. axios.get('http://127.0.0.1:8000/task')
389. .then(response => {
393. this.tasks = response.data.tasks;
397. });
399. },
401. initUpdate(index)
403. {
405. this.errors = [];
407. $("#update_task_model").modal("show");
409. this.update_task = this.tasks[index];
411. },
413. updateTask()
415. {
417. axios.patch('/task/' + this.update_task.id, {
419. name: this.update_task.name,
421. description: this.update_task.description,
423. })
425. .then(response => {
429. $("#update_task_model").modal("hide");
433. })
435. .catch(error => {
437. this.errors = [];
439. if (error.response.data.errors.name) {
441. this.errors.push(error.response.data.errors.name[0]);
443. }
447. if (error.response.data.errors.description) {
449. this.errors.push(error.response.data.errors.description[0]);
451. }
453. });
455. }
457. }
459. }
461. </script>

Now run the following command to compile the newly added code as a Vue.js component:

1. npm run dev

 

Conclusion

This Laravel Vue single-page app is a simple demonstration of how to combine Laravel Vue JS into an effective frontend and backend. I am sure you could easily extend this idea into a powerful application that simplifies development. Do give this Vue JS and Laravel SPA tutorial a try and let me know how it went in the comments below.

Make sure to leave a comment if you need help in understanding the Laravel SPA code or the idea.