Go to file

Jeff Avallone 6c17c40b34 Updating changelog		2020-09-05 14:04:11 -04:00
lib	Building site with just webpack	2020-09-05 12:41:45 -04:00
spec	Updating Karma	2020-09-05 13:27:15 -04:00
src	Building site with just webpack	2020-09-05 12:41:45 -04:00
static	Building site with just webpack	2020-09-05 12:41:45 -04:00
.babelrc	Building site with just webpack	2020-09-05 12:41:45 -04:00
.eslintrc.json	Adjusting eslint config	2020-09-05 09:06:17 -04:00
.firebaserc	Setting up for firebase deployments	2019-01-08 17:58:32 -05:00
.gitignore	Setting up for firebase deployments	2019-01-08 17:58:32 -05:00
.gitlab-ci.yml	Removing firebase token var from command line	2020-09-05 13:50:00 -04:00
LICENSE.txt	Adding basic readme and license	2014-11-23 11:41:53 -05:00
README.md	Updating build and docs tasks	2020-09-05 12:54:00 -04:00
changelog.json	Updating changelog	2020-09-05 14:04:11 -04:00
firebase.json	Setting up for firebase deployments	2019-01-08 17:58:32 -05:00
karma.conf.js	Updating Karma	2020-09-05 13:27:15 -04:00
package.json	Updating firebase deploy tool	2020-09-05 13:40:06 -04:00
webpack.config.js	Removing config.js	2020-09-05 13:31:02 -04:00
yarn.lock	Updating firebase deploy tool	2020-09-05 13:40:06 -04: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 is required for working with this site.

To start with, install the necessary dependencies:

$ yarn install

To start a development server, run:

$ yarn start

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:

$ yarn docs # Build documentation into the ./docs directory
$ yarn build # Build the site into the ./build directory
$ yarn test # Run JSCS lint and Karma tests

License

See LICENSE.txt file for licensing details.