https://github.com/timnew/chrome-boilerplate
https://github.com/timnew/chrome-boilerplate
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/timnew/chrome-boilerplate
- Owner: timnew
- License: mit
- Created: 2015-10-18T08:05:58.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-10-18T08:06:27.000Z (over 10 years ago)
- Last Synced: 2024-11-19T09:57:40.894Z (over 1 year ago)
- Language: JavaScript
- Size: 121 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Chrome Extension Boilerplate
Forked from [react-chrome-extension-boilerplate](https://github.com/jhen0409/react-chrome-extension-boilerplate)
Boilerplate for Chrome extension.
Removed the page codes, make the Boilerplate more suitable for , and with some additional minor optimization.
## Included
- [babel](https://github.com/babel/babel)
- [react](https://github.com/facebook/react)
- [redux](https://github.com/rackt/redux)
- [react-redux](https://github.com/gaearon/react-redux)
- [redux-devtools](https://github.com/gaearon/redux-devtools)
- [redbox-react](https://github.com/KeywordBrain/redbox-react)
- [webpack](https://github.com/webpack/webpack)
- [react-transform-hmr](https://github.com/gaearon/react-transform-hmr)
- [react-transform-catch-errors](https://github.com/gaearon/react-transform-catch-errors)
- [babel-plugin-react-transform](https://github.com/gaearon/babel-plugin-react-transform)
- [gulp-](https://github.com/gulpjs/gulp)
- [jade](https://github.com/phated/gulp-jade)
- ...
- [classnames](https://github.com/JedWatson/classnames)
- [todomvc-app-css](https://github.com/tastejs/todomvc-app-css)
- ...
## Installation
```bash
# required node.js/io.js
# clone it
npm install
# or npm way
npm install react-chrome-extension-boilerplate --dev
```
## Development
* Run script
```bash
# build files to './dev'
# start WebpackDevServer
npm run dev
```
* Allow `https://localhost:3000` connections (Because `injectpage` injected Github(https) pages, so `webpack-dev-server` procotol must be https.)
* Load unpacked extensions with `./dev`
#### React/Flux hot reload
This boilerplate uses `Webpack` and `react-transform`, and use `Redux`. You can hot reload by editing related files of Popup & Window.
## Build
```bash
# build files to './build'
npm run build
```
## Build & Compress ZIP file
```bash
# compress build folder to archive.zip
npm run compress
```
## Test
* `test/app`: React components, Redux actions & reducers tests
* `test/e2e`: E2E tests (use [chromedriver](https://www.npmjs.com/package/chromedriver), [selenium-webdriver](https://www.npmjs.com/package/selenium-webdriver))
```bash
npm run test-crdv // start chromedriver
npm test
```
## LICENSE
[MIT](LICENSE)