You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ Before you begin, ensure you have the following set up on your local machine.
21
21
22
22
#### Folder Structure
23
23
24
-
Your snap-in project directory must be a sibling to a clone of this`airdrop-shared` repository.
24
+
Your snap-in project directory must be in the same root directory as`airdrop-shared` repository.
25
25
26
26
```sh
27
27
# Your project layout should look like this
@@ -48,11 +48,11 @@ Clone the Codeplain client repository, which contains the code generation script
48
48
49
49
In the root of your new snap-in project directory, create and configure the following files.
50
50
51
-
-**`manifest.yaml`**
51
+
-**`manifest.yaml`**:
52
52
This file defines your snap-in's metadata. It is **not** generated automatically. You must create one tailored to your snap-in's needs. For guidance, refer to the [DevRev manifest documentation](https://developer.devrev.ai/public/airdrop/manifest).
53
53
54
-
-**`config.yaml`**
55
-
This file configures the code generation process. You must include paths pointing to the cloned `airdrop-shared` repository. Other fields can be adjusted to assist with rendering.
54
+
-**`config.yaml`**:
55
+
This file configures the code generation process. You must include paths pointing to the cloned `airdrop-shared` repository. Other fields can be adjusted to assist with code generation (rendering).
56
56
57
57
*Example `config.yaml`:*
58
58
@@ -68,7 +68,7 @@ In the root of your new snap-in project directory, create and configure the foll
68
68
# render-range: 2.3.1,2.3.2
69
69
```
70
70
71
-
- **`.env`**
71
+
- **`.env`**:
72
72
Create a `.env` file to store sensitive information and local paths. At a minimum, it must contain the absolute path to the `chef-cli` binary. Add any other variables, such as API credentials, that your project requires.
73
73
74
74
*Example `.env` for a Wrike snap-in:*
@@ -81,12 +81,12 @@ In the root of your new snap-in project directory, create and configure the foll
81
81
CHEF_CLI_PATH=/Users/yourname/path/to/chef-cli
82
82
```
83
83
84
-
- **`devrev-<external-system>-snapin.plain`**
85
-
This is the core specification file for your snap-in. It is highly recommended to copy the `.plain` file from an existing snap-in (like Trello or Wrike) and modify it. Start with a minimal set of functional requirements and expand as you go.
84
+
- **`devrev-<external-system>-snapin.plain`**:
85
+
This is the core specification file for your snap-in. It is highly recommended to copy the `.plain` file from an existing snap-in (like [Trello](https://github.com/devrev/airdrop-trello-snap-in) or [Wrike](https://github.com/devrev/airdrop-wrike-snap-in)) and modify it. Start with a minimal set of functional requirements and expand as you go.
86
86
87
87
- Learn more about the specification language: [Plain Language Specification Guide](https://github.com/Codeplain-ai/plain2code_client/blob/main/Plain-language-specification.md)
88
88
89
-
- **`test_data/`** (Folder)
89
+
- **`test_data/`**:
90
90
Create this folder to store JSON data files that your Acceptance tests will use.
91
91
92
92
### 3\. Running Code Generation
@@ -191,4 +191,4 @@ Your local snap-in repository can override any file from this shared repository.
191
191
192
192
- *Example*: To override `airdrop-shared/test_data/data_extraction_check.json`, create the file `your-new-snap-in/test_data/data_extraction_check.json`.
193
193
194
-
- **Scripts & Auxiliary Files**: To customize a script, copy it from `airdrop-shared/scripts/` into your snap-in's repository and modify it as needed. Remember to update the corresponding path in your `config.yaml`.
194
+
- **Scripts & Auxiliary Files**: To customize a script, copy it from `airdrop-shared/scripts/` into your snap-in's repository and modify it as needed. Remember to update the corresponding path in your `config.yaml`.
0 commit comments