2038 zapier integration 1 initialize a zapier app with a twenty related account (#2089)

* Add doc for Zapier development

* Add twenty-zapier package

* Install zapier packages

* Update doc

* Add twenty-zapier app

* Update doc

* Update apiKey slug

* Update integration

* Update create people to person

* Update version

* Fix lint

* Remove useless comments

* Update docs

* Update version

* Update naming

* Add prettier

* Simplify docs

* Remove twenty related stuff from public doc

* Use typescript boilerplate

* Update details
This commit is contained in:
martmull
2023-10-17 21:00:20 +02:00
committed by GitHub
parent 01e9545a59
commit 54735c4880
15 changed files with 2842 additions and 1 deletions

View File

@ -0,0 +1,29 @@
---
title: Zapier App
sidebar_position: 3
sidebar_custom_props:
icon: TbBrandZapier
---
## Setup
- Create a [Zapier account](https://zapier.com/)
- Install [Zapier CLI](https://platform.zapier.com/quickstart/cli-tutorial) globally: `npm install -g zapier-platform-cli`
- Login with CLI with your Zapier account credentials: `zapier login`
- Install Zapier packages:
```
cd packages/twenty-zapier
yarn
```
- set environment variables:
- In **packages/twenty-zapier** launch `cp .env.example .env`
- launch local application, go to `http://localhost:3000/settings/apis` and generate an apiKey
- copy and paste the api key to replace the .env **YOUR_API_KEY** value
- `cd .. && cd twenty-zapier` to set environment variables (needs autoenv)
## Development
- Test: `yarn test`
- Lint: `yarn format`
- Watch and compile as you edit code: `yarn watch`
- Validate your Zapier app: `yarn validate`
- Deploy your Zapier app: `yarn deploy`
- List all Zapier CLI commands: `zapier`. ⚠️ make sure to run `yarn build` before any `zapier` command

View File

@ -7,6 +7,7 @@ export {
TbBrandFigma,
TbBrandVscode,
TbBrandWindows,
TbBrandZapier,
TbBug,
TbBugOff,
TbChartDots,
@ -33,4 +34,3 @@ export {
TbZoomQuestion,
TbRocket
} from "react-icons/tb";