regexper-static/README.md

26 lines
1.0 KiB
Markdown
Raw Normal View History

2018-02-10 18:33:13 +00:00
# Regexper [![Build Status](https://travis-ci.org/javallone/regexper-static.svg?branch=react)](https://travis-ci.org/javallone/regexper-static)
2014-11-23 16:41:53 +00:00
2014-11-24 00:05:39 +00:00
Code for the http://regexper.com/ site.
2014-11-23 16:41:53 +00:00
## 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.
2014-11-24 00:04:47 +00:00
To start with, install the necessary dependencies:
2014-11-24 00:04:47 +00:00
$ yarn install
2014-11-24 00:04:47 +00:00
2016-10-15 21:46:37 +00:00
To start a development server, run:
2014-11-24 00:04:47 +00:00
$ yarn start
2014-11-24 00:04:47 +00:00
2014-11-23 16:41:53 +00:00
## License
2014-12-26 21:24:09 +00:00
See [LICENSE.txt](/LICENSE.txt) file for licensing details.