https://github.com/satrun77/flashcard

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.
https://github.com/satrun77/flashcard

api flashcard laravel laravel-package php

Last synced: 10 days ago
JSON representation

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.

• Host: GitHub
• URL: https://github.com/satrun77/flashcard
• Owner: satrun77
• License: mit
• Created: 2013-08-24T13:02:32.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2018-06-10T21:05:59.000Z (over 6 years ago)
• Last Synced: 2024-05-06T12:04:22.475Z (6 months ago)
• Topics: api, flashcard, laravel, laravel-package, php
• Language: PHP
• Homepage: https://flashcard.my.geek.nz/
• Size: 439 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
MooFlashCard

=============

[![SensioLabsInsight](https://insight.sensiolabs.com/projects/c60d35bc-17f3-40b7-9b17-f504b8a62270/mini.png)](https://insight.sensiolabs.com/projects/c60d35bc-17f3-40b7-9b17-f504b8a62270)

[![Build Status](https://travis-ci.org/satrun77/flashcard.svg?branch=master)](https://travis-ci.org/satrun77/flashcard)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/satrun77/flashcard/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/satrun77/flashcard/?branch=master)

[![Code Coverage](https://scrutinizer-ci.com/g/satrun77/flashcard/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/satrun77/flashcard/?branch=master)

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:

```bash

composer require moo/flashcard

```

Rebuild the cached package manifest

  

```bash

artisan package:discover 

```

Update your database with the package schema.

```bash

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](CHANGELOG.md) for more information what has changed recently.

### Demo

- You can view my personal use of this package - [Demo](http://flashcard.my.geek.nz/).

### License

This package is under the MIT license. View the [LICENSE.md](LICENSE.md) file for the full copyright and license information.