root
/
regexper-static
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
252 Commits 4 Branches 1 Tag 1.9 MiB
JavaScript 86.4%
HTML 8.4%
CSS 5.2%
Go to file
Jeff Avallone fc6ffbd73a Merging some shared styles 2014-12-30 10:17:55 -05:00
lib Integrating canopy (with a demo parser from the canopy docs) 2014-11-24 22:31:20 -05:00
spec Merging some shared styles 2014-12-30 10:17:55 -05:00
src Merging some shared styles 2014-12-30 10:17:55 -05:00
.gitignore Adding initial compass integration 2014-11-23 16:16:10 -05:00
.ruby-gemset Adding initial compass integration 2014-11-23 16:16:10 -05:00
.ruby-version Adding initial compass integration 2014-11-23 16:16:10 -05:00
Gemfile Adding initial compass integration 2014-11-23 16:16:10 -05:00
Gemfile.lock Adding initial compass integration 2014-11-23 16:16:10 -05:00
LICENSE.txt Adding basic readme and license 2014-11-23 11:41:53 -05:00
README.md Linking to LICENSE.txt file 2014-12-26 16:24:09 -05:00
config.js Adding a 404 page 2014-12-21 19:59:07 -05:00
gulpfile.js Using mold-source-maps to remove working path from source map 2014-12-30 10:01:29 -05:00
karma.conf.js Switching Karma test browser to Chrome 2014-12-04 19:11:30 -05:00
package.json Using mold-source-maps to remove working path from source map 2014-12-30 10:01:29 -05:00
template.html Merging the rendering code from main.js and regexper.js 2014-12-29 21:31:36 -05:00

README.md

Regexper

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 and Ruby are required for working with this site. It is recommended to use rbenv or rvm to manage your Ruby installation, and configuration files are included to set the Ruby version and gemset.

To start with, install the necessary dependencies for Node and Ruby:

$ bundle install
$ 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.

To automatically run Karma test, run the following:

$ gulp karma

To build the site for deployment, run the following:

$ gulp build

The site will be built into the "build" directory.

License

See LICENSE.txt file for licensing details.