This is a framwork for large web projects. ApiLaravue uses Laravel 5.4 as backend integrated with laravel passport and laravel cors, Vuejs as frontend and the two communicate via API calls. It also include redis already installed and configured in the backend and frontend, a node server already created and configure for realtime communication and some vue packages are also install in the frontend such as vue-router, vue-resource, vue-socket.io, and sweetalert.
Before starting with ApiLaravue 1.0, make sure you have some knowledge on:
- Laravel from the official Laravel documentation.
- Vuejs from the official Vuejs documentation
- Nodejs from the official Nodejs documentation
If you are up to the above standard, you can learn from
- our website ApiLaravue on gihub.io
- or from our docs repository
-
Run
$ composer create-project apilaravue/apilaravue
. -
Download and Intall nodejs for your OS from https://nodejs.org/en/download/
-
Install redis
$ wget http://download.redis.io/releases/redis-4.0.1.tar.gz $ tar xzf redis-4.0.1.tar.gz $ cd redis-4.0.1 $ make
if you are not having homebrew, intall it from https://brew.sh/ Run $ brew install redis
One click Redis install as a Windows service: https://github.com/rgl/redis/downloads Download and run the top .exe (ignore the "download as zip" button) Edit: For the latest versions of Redis for Windows look at MSOpenTech/redis. See Todd Menier's answer for more information.
-
start redis server Run
redis/server
and do not close the terminal window. Linux:src/redis-server
-
Open a new terminal window and CD to apilaravue/server.
-
Run
npm install
. This installs all dependencies. -
Run
node server.js
and do not close the terminal window. This will start the node server -
Open a new terminal window and CD to apilaravue/backend.
-
Run
composer install
. This installs all of Laravel's dependencies. -
Run
mv .env.example .env
. This enables your env files to set your app into local mode. -
Run
php artisan key:generate
. This generates a secure cipher key for encrypting your data. -
Create a database named
__laravelvue
-
Run
php artisan migrate --seed
-
Run
php artisan passport:install
-
Copy the
client secret
ofClient ID: 2
displayed in the terminal -
Edit the file
frontend/src/packages/config/backendConnection.js
and changeclient_secret
to what you have copied and save the file -
Run
php artisan serve
. This serves your application to the browser. You can also use Homestead, LAMP, WAMP, etc. -
Open a new terminal window and CD to apilaravue/frontend.
-
Run
npm install
. This installs all of Vue's dependencies. -
Run
npm run dev
. This will open the frontend landing view on your default browser. that ishttp://localhost:8080
-
Create something great!
If you are not familiar with vuejs, you should check their documentation at https://vuejs.org/v2/guide/
If you are not familiar with Laravel, you should check their documentation at https://laravel.com/docs/5.4
If you are not familiar with Nodejs, you should check their documentation at https://nodejs.org/api/http.html
you can also check the example at https://nodejs.org/api/synopsis.html
Or quick start with W3schools at https://www.w3schools.com/nodejs/nodejs_http.asp
Thank you for considering contributing to the ApiLaraVue framework.
If you discover a security vulnerability within ApiLaraVue, please send an e-mail to Kamga Simo Junior at kamgasimojunior@gmail.com. All security vulnerabilities will be promptly addressed.
The ApiLaraVue framework is open-sourced software licensed under the MIT license.