Skip to content

Commit

Permalink
chore: switch back to npm
Browse files Browse the repository at this point in the history
don't force devs to use yarn
  • Loading branch information
kevinchappell committed May 2, 2019
1 parent 4a0cfa9 commit e81be6c
Show file tree
Hide file tree
Showing 9 changed files with 21,003 additions and 11,629 deletions.
10 changes: 5 additions & 5 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ before_install:
jobs:
include:
- stage: lint
script: yarn lint
script: npm run lint
skip_cleanup: true
- stage: deploy
if: branch = master
Expand All @@ -35,17 +35,17 @@ jobs:
- python3 -V
- pip3 -V
- mkdocs -V
- yarn build:all
- npm run build:all
deploy:
provider: script
script:
- yarn travis-deploy-once "yarn semantic-release"
- npm run travis-deploy-once "npm run semantic-release"
skip_cleanup: true
after_deploy:
- yarn deploy
- npm run deploy
- git clone --depth 1 "https://${GH_TOKEN}:@github.com/${SITE_REPO}" "$SITE_DIR" 2> /dev/null || (cd "$SITE_DIR" ; git pull; cd ../)
- ls -l
- yarn deploy:site
- npm run deploy:site
env:
global:
- secure: Fzq6BMwpDtUVH6ONSD5cg3gxDl/6bL9d4xoCnb1Ck3jhLen7GVSBCVs8dTPP0J1kMUbcPfywdG5CrdTMUXtuT3i7uVEqDxemkWYLyKwtvtqWPSFFTS9WvLnoxPvpTnDDoXvU9DhZoFP5U6nEELZIcqJceGwpDReROvJM1LKug72su7LHG40FWPj3w1X5XvMMKZlp6ClFwHZYDs7ybDcWlz6s2TsdunW0JW15+KMEDVuPTKw5VVk6ytnC3j3XXNus8ARRH/vG7DWCOtOai2ckYHchqz9c37oms5xA8nT4+J4Se/sgvkZo/jfa5tJSOljppUxMwyyNdkEu3QIEVNPgBtQf34KhWFN+FivuZHK4qG12lyQvRcJYlBJvUeSp29KABZv8oESIso5/HD8cIOEVCLUXjhOkcLF8S6cSRag0+/PT0u7Aj/L0ONKNsYhikOM773ilmbt8Vb7tjSOi7aoLJBmUlNVJcT4wJwJFjoe7bUppeqj1pC/+2+aX/IJDX6LfX6kpSxKGUH/DfJpEXq0xjCfsa8aap2gXfbn9Exsynx6KlIyAMRkmTU7S7iMiBts1fKMZvks3wA8rR4b44EZO+qgP5EbTGhCsvLYl3f5TiRsJf+w9LQrtP4Vl8mOU0XFgfrKArGMp6KDp1x1cyF/X4LAO9ySSDu9IEUj7Ft3WyOs=
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ 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
$ npm i
$ npm 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/).
Expand Down
4 changes: 2 additions & 2 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ 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
$ npm i
$ npm 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/).
Expand Down
18 changes: 10 additions & 8 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,33 +3,35 @@
Here we'll cover a few common tasks developers might face when setting up formBuilder.

## Clone the repo

```bash
$ git clone [email protected]:kevinchappell/formBuilder.git form-builder && cd form-builder
```

## Install Dependencies
```bash
$ yarn install
```
or

```bash
$ npm install
```

## Local development

Once you've cloned the project and installed it's dependencies you can get a local version running by running:

```bash
$ yarn start
$ npm start
```

This will run the default webpack config and open a new browser tab and that serves a demo of the plugin. This demo can be used to test features and bugs.

## Languages

At the time of writing this, formBuilder is available in dozens of languages thanks to generous contributors around the world. If you would like to contribute, formBuilder's language repo can be found [here](https://github.com/kevinchappell/formBuilder-languages). By default formBuilder will load languages from https://formbuilder.online/assets/lang unless the `i18n.location` option is set.

## Custom Controls

See the Control and Control Plugin Architecture Documentation to learn about how to create custom controls.

- [Overview](https://formbuilder.online/docs/formBuilder/overview/)
- [Control](https://formbuilder.online/docs/formBuilder/controls/)
- [Control Plugins](https://formbuilder.online/docs/formBuilder/control-plugins/)
- [Overview](https://formbuilder.online/docs/formBuilder/overview/)
- [Control](https://formbuilder.online/docs/formBuilder/controls/)
- [Control Plugins](https://formbuilder.online/docs/formBuilder/control-plugins/)
4 changes: 2 additions & 2 deletions docs/editing-fonts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ formBuilder uses an icon font generated with Fontello. Fontello makes it easy fo
### Editing
To edit the current icon font, open terminal and run:
```bash
yarn font edit
npm run font edit
```

This will open and create a new session on fontello.com where you can choose new icons or upload your own.

### Saving
When finished, click the Save Session button and return to the terminal and type:
```bash
yarn font save
npm run font save
```

* Note *
Expand Down
10 changes: 4 additions & 6 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,19 @@
# Getting Started

## Download and install
formBuilder and formRender are available directly from [GitHub](https://github.com/kevinchappell/formBuilder/tree/master/dist) and through yarn/npm.

formBuilder and formRender are available directly from [GitHub](https://github.com/kevinchappell/formBuilder/tree/master/dist) and through npm.

Install module from package manager:
```bash
$ yarn add formBuilder
```
or

```bash
$ npm i --save formBuilder
```

Once you have the module/plugin installed, include it in your build process for vendor dependencies, add to html via `<script>` tag, or `wp_enqueue_script` for a WordPress website.

## Basic Example

```html
<!DOCTYPE html>
<html>
Expand All @@ -34,4 +33,3 @@ Once you have the module/plugin installed, include it in your build process for
</body>
</html>
```

Loading

0 comments on commit e81be6c

Please sign in to comment.