Skip to content

Commit

Permalink
Merge pull request #1073 from matuzalemsteles/RemoveScriptsElectric
Browse files Browse the repository at this point in the history
Remove script `electric` from root
  • Loading branch information
carloslancha authored Aug 9, 2018
2 parents 7f2a000 + 59cc392 commit 4db6de7
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 1 deletion.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,8 @@ If you want to contribute to this project and do not know where to start [good f

### Setup

#### Packages

1. Install NodeJS >= [v6.11.0](http://nodejs.org/dist/v6.11.0/), if you don't have it yet.

2. Install global dependencies:
Expand Down Expand Up @@ -124,6 +126,37 @@ If you want to contribute to this project and do not know where to start [good f
npm run test
```

#### Clayui.com

To contribute to the documentation and the site in general, you can try to run locally to test your changes:

1. Move to the site folder
```
cd clayui.com
```

2. Install dependencies:
```
yarn install
```

or

```
npm install
```

3. Run in development environment
```
npm run develop
```

If you want to test in a production environment so that you do not take risks of inconsistencies, in the root folder:

```
npm run site
```

### Important
Since travis is failing on executing a11y tests due to out of date suid you need to execute `npm run a11y` locally before sending any pr to verify we're following accessibility standars.

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"start": "http-server . -p 4000",
"test": "npm run build && npm run jest && npm run a11y",
"testSoy": "cd packages/clay-isomorphic && ./gradlew testSoy",
"electric": "npm run soy && npm run compile && cd packages/clayui.com && ../../node_modules/electric-cli/bin/electric.js"
"site": "cd clayui.com && npm run build && npm run serve"
},
"devDependencies": {
"babel-preset-metal": "^4.1.0",
Expand Down

0 comments on commit 4db6de7

Please sign in to comment.