moo / flashcard-bundle
Laravel package that provides a simple flash card system with REST API.
Installs: 43
Dependents: 0
Suggesters: 0
Security: 0
Stars: 3
Watchers: 2
Forks: 0
Open Issues: 0
Type:laravel-package
Requires
- php: >=7.1
- illuminate/console: ^5.6
- illuminate/database: ^5.6
- illuminate/http: ^5.6
- mockery/mockery: ^1.1
- spatie/laravel-query-builder: ^1.9
- spatie/laravel-sluggable: ^2.1
Requires (Dev)
- orchestra/testbench: ~3.5.0|~3.6.0
- phpunit/phpunit: ^7.1
README
This package provides model for card & category to organise simple flash card system. It provide an API end-point to query for cards or categories.
Installation
Install the package via composer:
composer require moo/flashcard
Rebuild the cached package manifest
artisan package:discover
Update your database with the package schema.
artisan migrate
DONE!
API Usage
Query Categories
Request all categories
/api/categories
Request categories by search query
/api/categories?filter[custom]=search_query
Query Cards
Request all cards
/api/cards
Request cards by search query
/api/cards?filter[custom]=search_query
Request cards & include category details for each card
/api/cards?include=category
Request cards with pagination
/api/cards?page=1&limit=20
Request all card by id
/api/cards/{id}
Changelog
Please see CHANGELOG for more information what has changed recently.
Demo
- You can view my personal use of this package - Demo.
License
This package is under the MIT license. View the LICENSE.md file for the full copyright and license information.