Go to file
Jeff Avallone fa977fe791 Integrating webpack build into gulpfile 2016-10-15 17:45:18 -04:00
lib Removing gulp JS build scripting 2016-10-15 12:55:50 -04:00
spec Configuring karma to work with webpack 2016-10-15 12:55:50 -04:00
src Removing dead path 2016-10-15 17:44:37 -04:00
.babelrc Removing babel-plugin-transform-runtime 2015-12-21 14:50:33 -05:00
.gitignore Reworking how styles are built and how SVG styles are included 2015-11-01 10:04:16 -05:00
.jscsrc Adding JSCS integration 2015-11-01 10:18:31 -05:00
.travis.yml Removing karma gulp tasks in favor or npm script 2016-10-15 12:55:50 -04:00
LICENSE.txt Adding basic readme and license 2014-11-23 11:41:53 -05:00
README.md Adding Travis CI build status to README 2016-07-27 11:27:39 -04:00
config.js Fixing lint errors 2015-11-01 10:28:37 -05:00
gulpfile.js Integrating webpack build into gulpfile 2016-10-15 17:45:18 -04:00
karma.conf.js Configuring karma to work with webpack 2016-10-15 12:55:50 -04:00
package.json Adding webpack config for build styles 2016-10-15 17:44:35 -04:00
webpack.config.js Tweaking webpack config 2016-10-15 17:44:37 -04:00

README.md

Regexper Build Status

Code for the http://regexper.com/ site.

Contributing

I greatly appreciate any contributions that you may have for the site. Feel free to fork the project and work on any of the reported issues, or let me know about any improvements you think would be beneficial.

When sending pull requests, please keep them focused on a single issue. I would rather deal with a dozen pull requests for a dozen issues with one change each over one pull request fixing a dozen issues. Also, I appreciate tests to be included with feature development, but for minor changes I will probably not put up much of a fuss if they're missing.

Working with the code

Node is required for working with this site.

To start with, install the necessary dependencies:

$ npm install

There are several gulp tasks available to build various parts of the site, but to get started you only need:

$ gulp

This will build the site into the ./build directory, start a local start on port 8080, and begin watching the source files for modifications. The site will automatically be rebuilt when files are changed. Also, if you browser has the LiveReload extension, then the page will be reloaded.

These other gulp tasks are available:

$ gulp docs # Build documentation into the ./docs directory
$ gulp build # Build the site into the ./build directory
$ gulp verify # Run JSCS lint and Karma tests
$ gulp verify:watch # Run JSCS lint and Karma tests when files change
$ gulp lint:fix # Automatically fix some lint errors

License

See LICENSE.txt file for licensing details.