README.md

vue-postgrest

Vue.js Component providing PostgREST integration

Docs

See the official documentation

Quick Start

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

yarn add vue-postgrest
# OR npm install vue-postgrest

Import and install the Plugin in your main.js:

import Vue from 'vue'
import Postgrest from 'vue-postgrest'

Vue.use(Postgrest)

You can use the <postgrest> component:

<postgrest route="ROUTE" query={}>
  <template #default="{ items }">
    {{ items }}
  </template>
</postgrest>

Use the pg mixin:

<template>
  <div>{{ pg.items }}</div>
</template>

<script>
import { pg } from 'vue-postgrest'

export default {
  mixins: [pg],
  computed: {
    pgConfig () {
      return {
        route: 'ROUTE',
        query: {}
      }
    }
  }
}
</script>

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

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!