Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/technowledgy/vue-postgrest

PostgREST integration for Vue.js
https://github.com/technowledgy/vue-postgrest

Last synced: about 1 month ago
JSON representation

PostgREST integration for Vue.js

Lists

README 

        



[![GitHub Actions](https://img.shields.io/github/actions/workflow/status/technowledgy/vue-postgrest/push.yaml?branch=main)](https://github.com/technowledgy/vue-postgrest/actions/workflows/push.yaml)

[![Coveralls GitHub](https://img.shields.io/coveralls/github/technowledgy/vue-postgrest)](https://coveralls.io/github/technowledgy/vue-postgrest)

[![Dependabot](https://img.shields.io/badge/dependabot-enabled-success)](https://github.com/technowledgy/vue-postgrest/blob/main/package.json)

[![License](https://img.shields.io/npm/l/vue-postgrest)](https://github.com/technowledgy/vue-postgrest/blob/main/LICENSE)

[![npm](https://img.shields.io/npm/v/vue-postgrest)](https://www.npmjs.com/package/vue-postgrest)

![vue](https://img.shields.io/badge/vue-2.x-brightgreen)






# vue-postgrest

Vue.js Component providing PostgREST integration



## Docs



[See the official documentation](https://technowledgy.github.io/vue-postgrest/)



## Quick Start



To get started, install vue-postgrest via your package manager:



``` bash

yarn add vue-postgrest

# OR npm install vue-postgrest

```



Import and install the Plugin in your `main.js`:



``` javascript

import Vue from 'vue'

import Postgrest from 'vue-postgrest'



Vue.use(Postgrest)

```



You can use the `` component:



``` html



  

    {{ items }}

  



```



Use the `pg` mixin:



``` vue



  
{{ pg.items }}



import { pg } from 'vue-postgrest'



export default {

  mixins: [pg],

  computed: {

    pgConfig () {

      return {

        route: 'ROUTE',

        query: {}

      }

    }

  }

}



```



Or you can directly use the instance method provided on your Vue instance:



``` javascript

this.$postgrest.ROUTE.get()

```



## Contributing



We actively welcome your pull requests:



1. Fork the repo and create your branch from main.

2. If you've added code that should be tested, add tests.

3. If you've changed APIs, update the documentation.

4. Ensure the test suite passes.

5. Make sure your code lints.

6. Create a pull request.



Thank you!