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
[Online documentation on Gitbook](https://icebob.gitbooks.io/vueformgenerator/content/)
33
37
34
38
## Dependencies
39
+
35
40
vue-form-generator uses [fecha](https://github.com/taylorhakes/fecha) and [lodash](https://lodash.com/) internally.
36
41
37
-
While built-in fields don't need external dependencies, optional fields may need other libraries.
42
+
While built-in fields don't need external dependencies, optional fields may need other libraries.
38
43
These dependencies fall into two camps: jQuery or Vanilla. You can find almost the same functionality in both flavors.
39
44
In the end, it's your choice to depend on jQuery or not.
40
45
41
46
You can find details about dependencies in the official [documentation](https://icebob.gitbooks.io/vueformgenerator/content/) under each specific component.
42
47
43
48
## Installation
49
+
44
50
### NPM
51
+
45
52
You can install it via [NPM](http://npmjs.org/) or [yarn](https://yarnpkg.com/).
This command will start a `webpack-dev-server` with content of `dev` folder.
195
+
180
196
```bash
181
197
npm run dev
182
198
```
183
199
184
200
## Build
201
+
185
202
This command will build a distributable version in the `dist` directory.
203
+
186
204
```bash
187
205
npm run build
188
206
```
189
207
190
208
## Test
209
+
191
210
```bash
192
211
npm test
193
212
```
194
-
or
213
+
214
+
or
215
+
195
216
```bash
196
217
npm run ci
197
218
```
198
219
199
-
## More fields *new*
200
-
VueFormGenerator supports custom fields. If you decide to release your custom field into the wild, please open a new issue so we can add you to a list here! Please try to use this naming convention for your custom field : vfg-field-* Example :
220
+
## More fields _new_
201
221
202
-
-`vfg-field-myfield`
203
-
-`vfg-field-calendar`
204
-
-`vfg-field-awesome-dropdown`
222
+
VueFormGenerator supports custom fields. If you decide to release your custom field into the wild, please open a new issue so we can add you to a list here! Please try to use this naming convention for your custom field : vfg-field-\* Example :
223
+
224
+
*`vfg-field-myfield`
225
+
*`vfg-field-calendar`
226
+
*`vfg-field-awesome-dropdown`
205
227
206
228
This way, it will be easier for everyone to find it. Thank you !
207
229
208
230
### Public Custom Fields
209
231
210
-
-[vue-tel-input](https://github.com/EducationLink/vue-tel-input) - International Telephone Input Boilerplate with Vue (integrated with VueFormGenerator).
211
-
-[vfg-field-sourcecode](https://github.com/gwenaelp/vfg-field-sourcecode) - A source code field for vue-form-generator
212
-
-[vfg-field-array](https://github.com/gwenaelp/vfg-field-array) - A vue-form-generator field to handle arrays of items of any type.
213
-
-[vfg-field-object](https://github.com/gwenaelp/vfg-field-object) - A vue-form-generator field to handle objects, with or without schemas.
232
+
*[vue-tel-input](https://github.com/EducationLink/vue-tel-input) - International Telephone Input Boilerplate with Vue (integrated with VueFormGenerator).
233
+
*[vfg-field-sourcecode](https://github.com/gwenaelp/vfg-field-sourcecode) - A source code field for vue-form-generator
234
+
*[vfg-field-array](https://github.com/gwenaelp/vfg-field-array) - A vue-form-generator field to handle arrays of items of any type.
235
+
*[vfg-field-object](https://github.com/gwenaelp/vfg-field-object) - A vue-form-generator field to handle objects, with or without schemas.
214
236
215
237
## Contribution
238
+
216
239
Please send pull requests improving the usage and fixing bugs, improving documentation and providing better examples, or providing some testing, because these things are important.
217
240
218
241
## License
242
+
219
243
vue-form-generator is available under the [MIT license](https://tldrlegal.com/license/mit-license).
0 commit comments