<p align="center">
<img alt="Vue Eloquent" src="https://raw.githubusercontent.com/cimd/vue-eloquent-docs/main/docs/public/banner.png" />
</p>

<p align="center">
An interface for Vue 3 and Laravel Eloquent models through API requests.
</p>

<p align="center">
<img src="https://img.shields.io/npm/dm/@konnec/vue-eloquent" alt="Monthly downloads">
<img src="https://img.shields.io/badge/Vue.js%203-compatible-green.svg" alt="Vue.js 3 compatible">
<img src="https://img.shields.io/badge/license-MIT-green.svg" alt="License"></a>
<img src="https://img.shields.io/badge/TypeScript-supported-blue" alt="TypeScript Supported">
<img alt="Maintenance Status" src="https://img.shields.io/badge/maintenance-active-green.svg" />
<img alt="Code Coverage" src="https://img.shields.io/nycrc/cimd/vue-eloquent" />
</p>

## Installation

There are two packages available that can be used independently, but work better together.

### Vue 3 Package
`yarn add @konnec/vue-eloquent`

#### Vue Requirements
1. `Vue 3`

### Laravel Package
`composer require konnec/vue-eloquent-api`

#### Laravel Requirements
1. `Laravel 10+`
2. `PHP ^8.1`

## Documentation

Visit [Vue Eloquent Docs](https://vue-eloquent.netlify.app/)

# Maintenance Status

`Active`: We're actively working on this project, and we expect to continue for work for the foreseeable future. 
Bug reports, feature requests and pull requests are welcome.

# Contribution

Any ideas are welcome. Feel free to submit any issues or pull requests.

# License

The MIT License (MIT). Please see License File for more information.
