Skip to content

Commit

Permalink
fix(docs): Add missing documentation (kevinchappell#855)
Browse files Browse the repository at this point in the history
* fix(docs): Add missing documentation

Improve CI

* lock dependency versions except mi18n

* fix(safename): do not toLowerCase name fields

resolves kevinchappell#678

resolves kevinchappell#648
  • Loading branch information
kevinchappell authored and peter committed Nov 21, 2018
1 parent e16e3c0 commit f524ca0
Show file tree
Hide file tree
Showing 50 changed files with 2,256 additions and 522 deletions.
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "site"]
path = site
url = git@github.com:kevinchappell/formBuilder-site.git
58 changes: 40 additions & 18 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,23 +1,45 @@
sudo: required
stages:
- lint
- test
- deploy
language: node_js
node_js: lts/*
sudo: false
node_js: '10'
cache:
yarn: true
directories:
- "~/.npm"
- node_modules
deploy:
- provider: releases
notifications:
email: false
git:
submodules: false
jobs:
include:
- stage: lint
script: yarn lint
skip_cleanup: true
api_key:
secure: $GITHUB_RELEASES
on:
repo: kevinchappell/formBuilder
branch: master
- provider: npm
email: kevin.b.chappell@gmail.com
api_key:
secure: $NPM_KEY
on:
tags: true
repo: kevinchappell/formBuilder
branch: master
- stage: deploy
if: branch = master
before_deploy:
- echo "https://${GH_TOKEN}:@github.com" > .git/credentials
- git config credential.helper "store --file=.git/credentials"
- git config --global user.email "bot@formbuilder.online"
- git config --global user.name "🤖"
- sudo apt-get -y install python3-pip python-dev
- sudo pip3 install -U setuptools
- sudo pip install mkdocs
- python3 -V
- pip3 -V
- mkdocs -V
- yarn build
deploy:
provider: script
script:
- yarn travis-deploy-once "yarn semantic-release"
skip_cleanup: true
after_deploy:
- yarn deploy
env:
global:
- secure: mKHa/u/PeXUUroLwtaUkXOj3aaokU/2Nmp/esViUwz9VQHzvyEKKmpbuUQ2Vz4+TXXL5WtXIAD2to3+LrLAb784MD9GGHXWmJp1CvtGj0I4FbfbtvtSVMKezXRanwEYQCW/ozIvjB3X4ha780tb3yBdydwHWN1wriPaXUpP/D4FJT/GALEhk6OkbQXhpJzm++TfXAaTzWrfLNAzmmDTCTMFA6YeFVzf90TGYUWW+vIYjMItvJbIdvuoPNMKfUH/6m1AaAMU63lgJSYLhIFxHvTDj1valIsD5/lxhdjeRIjdc96j45tkxIvZOim6tXP//se8dyFWWSDxP5DErpQuUb7Lgzmj8bs+BPao3nm+6UBJ+SjD+4WhIDElBMwRBPqzA4leNSvt4p1yKUBGyFYMYFd/Y7OaI/LsHYPfMagJk+gUGvBGmTJy1bGXjPQ2Eejl8HaLVTDnVcjVsWxkB8why+GKKEuqCiRFgiirxSRfXF3LACzpBasfH8SdQqaadWcSkz2fMOkANyhFAhDQjlLU0Y9K8YCGpta2T4qrHf8QiR2UhEUaafuoWzGKbZBoQjVk05UJoKMFt+kl8ie39y4PUCMw+3SBcBbeqYShMF+l5Tcd93UQpa72fzSgz61J6wBYikO4Xe/ecZ4U8VMWgIyjZziFjjzOV367AmSnkUjcGqMw=
- secure: nKf6rLgTxC5KU69ZRAdiS/yQaHwA1PvI/ZSLu4/IswtXBLMbx65/HNJjGt1n+ycCkcWIwU9Ncp1uBIQbkFUranvYv0LjmIIZ36KfRQI27CZaLWGDZNqIcKSPNTr08UZEQbUzxeglUiJQim333ohYhVeXy2rnsJg0uTsaCPl/c58Yy3dtt4Z8KlPLGzKpUsn75vEED7/Wz6waCKasCn8yW3/30KImQ3a3KT5Lj5VgIavcrgQIao6KgMykNq/ECLRyliAtSF7AZqGiXvzIrmIJApySGEVwy6B+2n/Sc9ZVp2NC5oIBct9CggAvgzVlP5IdGzKQbRWO2uKFy4TGUsY2FgvfWODOWsG0BPp8TI31atlQcfzXEicQFqokmX/ZMj4nV1jVOD/R1Spz+03DUsLVTHM0y61ZeWTo3qIcohJBpqoaprXiHj1dQYOwubCM0fCQIZKQ36x5xk1RYARJBei6w0h3/3iASvdmF29Maq8906gMxEfj9B8N5xiV9kHM9KMUETVX7rdYABZ2jWQtL93AXdU4LqKKXFTCanBy8dJROtl254T4H8JX5RvGBxMylxwpDr9/mP+SCeNOJ8Pft6Si0RQiSSWCv8tbgGebA++p2TpJlVjaJkDqmxv9UkxPS0cdpi8YWWxzS/5axkTTioAlkyOUNhECJiMq9bL+EwMcN5o=
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@
- v2.2.3 - Return unformatted JSON by default [#481](https://github.com/kevinchappell/formBuilder/pull/481)
- v2.2.2 - Hotfix: getData [#464](https://github.com/kevinchappell/formBuilder/pull/464)
- v2.2.1 - Hotfix: bootstrap addon style, Update documentation
- v2.2.0 - Feature: Controls API, see: http://formbuilder.readthedocs.io/en/latest/formBuilder/overview/
- v2.2.0 - Feature: Controls API, see: https://formbuilder.online/docs/formBuilder/overview/
Feature: Injected styles, no longer to need include css file.
- v2.1.2 - Update npm scripts
- v2.1.1 - Required checkbox fix, form-horizontal css alignment fix [#422](https://github.com/kevinchappell/formBuilder/pull/422)
Expand Down
17 changes: 16 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,25 @@ While not required, the following tools are recommended to maintain code quality
- [ESLint](http://eslint.org/)
- [SASS-lint](https://www.npmjs.com/package/sass-lint)

## Installation

Navigate to the directory you'll be working from and run:
```bash
$ git clone https://github.com/kevinchappell/formBuilder.git form-builder
$ cd form-builder
$ yarn
$ yarn start
```

The above code will clone the repo, install the required `node_modules` and run the default `npm start` script. You should now have a locally running version of the [demo page](https://kevinchappell.github.io/formBuilder/).

## Getting Started
If you've followed the above steps you're ready to start making changes. All changes to the plugin should be made in the `/src` directory. The build process will transpile, lint and concatenate the contents of `/src` into the files found in `/dist`. Any changes made in the `/dist` will be lost once the build process is run.

For more information on build processes, editing fonts or adding custom fields please see the documentation [here](http://formbuilder.readthedocs.org/en/latest/).
For more information on build processes, editing fonts or adding custom fields please see the documentation [here](https://formbuilder.online/docs/).

## Documentation
For more information on build processes, editing fonts or adding custom fields please see the development section [here](https://formbuilder.online/docs/development/).

## Notes
Windows users, remember to configure your line endings with `core.autocrlf`. More info [here](https://help.github.com/articles/dealing-with-line-endings/#platform-windows)
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
formBuilder v2.10.3
formBuilder
===========

[![Join the chat at https://gitter.im/kevinchappell/formBuilder](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/kevinchappell/formBuilder?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Expand All @@ -16,7 +16,7 @@ jQuery($ => {
## [Demo](https://formbuilder.online/)
[![form-builder](https://cloud.githubusercontent.com/assets/1457540/16901016/d415f75c-4c2e-11e6-8687-a84c9822162d.png)](https://formbuilder.online/)

## [Documentation](http://formbuilder.readthedocs.io/en/latest)
## [Documentation](https://formbuilder.online/docs)

## [Angular 2/4 Version](https://github.com/KhaledSMQ/Ng2FormBuilder)

Expand Down
3 changes: 2 additions & 1 deletion demo/assets/js/demo.min.js

Large diffs are not rendered by default.

Binary file modified demo/assets/js/demo.min.js.gz
Binary file not shown.
10 changes: 6 additions & 4 deletions demo/assets/js/form-builder.min.js

Large diffs are not rendered by default.

Binary file modified demo/assets/js/form-builder.min.js.gz
Binary file not shown.
10 changes: 6 additions & 4 deletions demo/assets/js/form-render.min.js

Large diffs are not rendered by default.

Binary file modified demo/assets/js/form-render.min.js.gz
Binary file not shown.
Loading

0 comments on commit f524ca0

Please sign in to comment.