README.md 1.38 KB
Newer Older
Jeff Avallone's avatar
Jeff Avallone committed
1
# Regexper
2

Jeff Avallone's avatar
Jeff Avallone committed
3
Code for the http://regexper.com/ site.
4
5
6
7
8
9
10
11
12

## 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

13
Node is required for working with this site.
Jeff Avallone's avatar
Jeff Avallone committed
14

15
To start with, install the necessary dependencies:
Jeff Avallone's avatar
Jeff Avallone committed
16

17
    $ yarn install
Jeff Avallone's avatar
Jeff Avallone committed
18

Jeff Avallone's avatar
Jeff Avallone committed
19
To start a development server, run:
Jeff Avallone's avatar
Jeff Avallone committed
20

21
    $ yarn start
Jeff Avallone's avatar
Jeff Avallone committed
22

23
24
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.

Jeff Avallone's avatar
Jeff Avallone committed
25
These other gulp tasks are available:
26

Jeff Avallone's avatar
Jeff Avallone committed
27
28
    $ yarn docs # Build documentation into the ./docs directory
    $ yarn build # Build the site into the ./build directory
29
    $ yarn test # Run JSCS lint and Karma tests
30
31
32

## License

Jeff Avallone's avatar
Jeff Avallone committed
33
See [LICENSE.txt](/LICENSE.txt) file for licensing details.