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

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jonyw4 committed Oct 22, 2020
1 parent 02c47af commit 65652da
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 42 deletions.
2 changes: 0 additions & 2 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,9 @@
"extensions": [
"christian-kohler.path-intellisense",
"christian-kohler.npm-intellisense",
"github.vscode-pull-request-github",
"mhutchie.git-graph",
"dbaeumer.vscode-eslint",
"joelday.docthis",
"naumovs.color-highlight",
"esbenp.prettier-vscode",
"mikehanson.auto-barrel",
"streetsidesoftware.code-spell-checker",
Expand Down
44 changes: 4 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,46 +5,18 @@

📄 Plugin para [Vendure](https://github.com/vendure-ecommerce/vendure) para emitir NFe pelo Vendure usando Webmania BR. O plugin está em fase de testes e tem apenas o necessário para emitir nota fiscal.

## 🌟 Features
- Emite nota fiscal quando transaciona o status `Packed`.
- Adiciona `customFields` em `Address`, `Order` e `Product`

## ❗ Requisitos:
- `@vendure/core` >= 0.14.0
- `@vendure-advanced-shipping/core` >=2.1.1
- [Conferir como os dados são montados para verificar se bate com os requisitos da sua loja](https://github.com/jonyw4/vendure-webmaniabr-plugin/blob/master/src/custom-validation-proccess.ts). Se algum campo faltar por favor abrir PR ou mandar issue
- Cadastrar possíveis caixas que serão utilizadas no envio. Para isso usamos o [plugin *Advanced Shipping*](https://github.com/jonyw4/vendure-advanced-shipping)

**Você PRECISA preencher os seguintes campos no Vendure para emitir a nota fiscal**.
### `Product`
- customFields.ncm
- customFields.origem
- customFields.massUnit
- customFields.weight

**Você PRECISA solicitar os seguintes campos para seu usuário antes de finalizar a compra**:
- `@vendure/core` ~ 0.16.0

### `Address` (`BillingAddress` e `ShippingAddress`)
- city
- country
- postalCode
- phoneNumber
- customFields.isCompany
- customFields.cpfCnpj
- customFields.rgIE
- customFields.addressNumber
- customFields.addressComplemento
- customFields.uf
## Como funciona?
Esse plugin cria um `CustomFulfillmentProcess` onde executa a biblioteca javascript do WebmaniaBR para criar NFe. Você determina em qual condição a NFe será criada e também como será salva.

## ⚙️ Instalação
### 1. Instale e configure o Vendure
### 2. Instale e configure o [Vendure Advanced Shipping](https://github.com/jonyw4/vendure-advanced-shipping#%EF%B8%8F-install)
### 3. Instale o pacote
```bash
npm install vendure-webmaniabr-plugin --save
```

### 4. Add o plugin nas configurações inserindo suas chaves e escolhendo a sua configuração
### Add o plugin nas configurações inserindo suas chaves e escolhendo a sua configuração
```typescript
import { WebmaniaBRPlugin } from '@vendure-advanced-shipping/core';
const config: VendureConfig = {
Expand All @@ -62,13 +34,5 @@ const config: VendureConfig = {
}
```

### 📚 Como usar?
Depois de configurado agora podemos cadastrar informações referente a NFe na pagina do produto, como também temos como solicitar esses dados ao cliente.

- Todos dados da NFe do produto estarão disponíveis na página do produto.
- Para preencher os dados pedidos nos requisitos ao cliente você precisara utilizar a _mutation_ `setOrderBillingAddress` e `setOrderShippingAddress` em seu _storefront_
- Sempre que uma NFe é criada é salvo o ID do WebmaniaBR no _customField_ `nfeUuid` em `Order`.
- O plugin está em fase de testes e tem apenas os campos obrigatórios para a emissão da nota fiscal. Se você deseja que algum campo ou recurso seja adicionado, crie um PR ou uma issue para discutirmos.

## ❗️ Licença
MIT

0 comments on commit 65652da

Please sign in to comment.