Skip to content
This repository has been archived by the owner on Jan 15, 2022. It is now read-only.

Commit

Permalink
ci: update ci
Browse files Browse the repository at this point in the history
  • Loading branch information
jonyw4 committed Aug 10, 2020
1 parent 4ce5f67 commit 0804d42
Show file tree
Hide file tree
Showing 3 changed files with 74 additions and 3 deletions.
37 changes: 37 additions & 0 deletions .github/workflows/build_and_test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Build & Test
on:
push:
branches:
- master
- next
pull_request:
branches:
- master
- next
env:
CI: true
node: 12.x
jobs:
tests:
if: "!contains(github.event.head_commit.message, 'skip ci')"
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: Use Node.js ${{ env.node }}
uses: actions/setup-node@v1
with:
node-version: ${{ env.node }}
- name: Cache Node.js modules
uses: actions/cache@v1
with:
path: ~/.npm
key: ${{ runner.OS }}-node-${{ hashFiles('**/package-lock.json') }}
restore-keys: |
${{ runner.OS }}-node-
${{ runner.OS }}-
- name: Install & build
run: |
yarn install
yarn build
- name: Unit tests
run: yarn test
2 changes: 0 additions & 2 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,5 @@ jobs:
run: |
yarn install
yarn build
- name: Test
run: yarn test
- name: Deploy Package
run: npx semantic-release
38 changes: 37 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,40 @@
![Build & Test](https://github.com/jonyw4/vendure-reviews-plugin/workflows/Build%20&%20Test/badge.svg)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

Its working in Progress
⭐ Multiple plugins for [Vendure](https://github.com/vendure-ecommerce/vendure) to review about Products, Order and Company

## 🌟 Features
- Ability to customer create review of the Company using with [NPS](https://en.wikipedia.org/wiki/Net_Promoter)
- Manage the state of reviews approving every changes by the customer
- On every change of state its dispatch a new Event, so you can extend the features of this package to send email or something like that

## Todo
- Admin UI
- Products Review
- Order Review

## ⚙️ Install
### 1. Install and configure Vendure
[Here](https://www.vendure.io/docs/getting-started/) you can find out how to install

### 2. Install the package
```bash
npm install vendure-reviews-plugin --save
```

### 3. Add the plugin in Vendure configuration
```typescript
import { ReviewsStorePlugin } from 'vendure-reviews-plugin';
const config: VendureConfig = {
...
plugins: [
ReviewsStorePlugin
]
}
```

## 📚 How to use?
If you want to use queries and mutation of this package [you can see the all on this file](https://github.com/jonyw4/vendure-reviews-plugin/tree/src/api/schema)

## ❗️ License
MIT

0 comments on commit 0804d42

Please sign in to comment.