Git Product home page Git Product logo

maven's Introduction

Maven

A Laravel package to manage FAQ.
(This package is for Laravel 5.2+)

Demo

'Example'

Requirements

Installation

Add this package name in composer.json

"require": {
  "sukohi/maven": "2.*"
}

Execute composer command.

composer update

Register the service provider in app.php

'providers' => [
    ...Others...,
    Collective\Html\HtmlServiceProvider::class,
    Sukohi\Cahen\CahenServiceProvider::class,
    Sukohi\Maven\MavenServiceProvider::class,
]

Also alias

'aliases' => [
    ...Others...,
    'Form' => Collective\Html\FormFacade::class,
    'Html' => Collective\Html\HtmlFacade::class,
    'Cahen'   => Sukohi\Cahen\Facades\Cahen::class,
    'Maven'   => Sukohi\Maven\Facades\Maven::class,
]

And execute the next commands.

php artisan vendor:publish
php artisan migrate

Usage (Management page)

Set a route in your routes.php.

Route::match(['get', 'post'], 'maven', function () {

    return \Maven::view();
    
});

Now you can access management page that Maven provides like http://YOUR-DOMAIN/maven.
Note: I believe that you need to authenticate in routes.php before calling Maven::view().

Usage (Retrieve data)

(in Controller)

$faqs = \Maven::get();

// or

$faqs = \Maven::tag('YOUR-TAG')->get();
$faqs = \Maven::tag(['YOUR-TAG-1', 'YOUR-TAG-2'])->get();

// or

$faqs = \Maven::locale('en')->get();
$faqs = \Maven::locale(['en', 'es'])->get();

// or

$faq = \Maven::uniqueKey('952557a09ef19aae1d9e2a276db18a66')->first();

(in View)

<!-- Data -->

@foreach($faqs as $faq)
    <a id="{{ $faq->unique_key }}"></a>
    {!! $faq->question !!}<br><br>
    {!! $faq->answer !!}<br><br>
    Tag: {!! implode(',', $faq->tags) !!}
    <hr>
@endforeach

<!-- Pager -->

{!! $faqs->links() !!}

Command

You can export/import faq data like so.

(Export)

php artisan maven:export
  • Exported file will be saved at storage/app/maven/faq.json.

(Import)

php artisan maven:import

License

This package is licensed under the MIT License.

Copyright 2016 Sukohi Kuhoh

maven's People

Contributors

sukohi avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.