Skip to content

bbtran/Regexcellence

 
 

Repository files navigation

Regexcellence

Regexcellence is a community driven educational tool for learning about regular expressions.

#Version 1.0.0

About the app

Let's face it, learning the wacky syntax of regular expressions is tough. One good tutorial may give you enough to get started with being fluent in this subset of programming languages, but it sure won't make you an expert in it. Regular expressions aren't used that often in code, so when a use case does come about, most of us are left googling for a pre-packaged regex that does the job for us, without a good notion of what the heck it's doing.

Now enter Regexcellence.

Regexcellence is similar to many other coding challenge websites, like Codewars, Coderbyte, etc., except it purely focuses on regular expressions. It also takes inspiration from the excellent tutorial Regexone.com, where user input is immediately interpreted and matched against the provided test cases. In this way, Regexcellence cuts itself into a niche of the programming community, one where you can really test your steel in the land of regular expressions.

Regexcellence currently consists of a regex tutorial that walks the user through the basics of regular expressions, and a community platform for both attempting regular expression problems and contributing original problems.

Team

Our Tech Stack

Frontend

  • React-Redux for rendering page views and maintaining state
  • Bootstrap - a mobile first styling framework
  • XRegexP - a Javascript Regular Expressio

Backend

Testing

Dev/Build Tools

##Folder and File Structure Regexcellence/ | |--client/ | |--actions/ | |--challenge/ | |--login/ | |--pages/ | |--reducers/ | |--tutorials/ | |--user-posts/ | |--user-profile/ | |--userChalleges/ | |--styles/ | |--SASS/SCSS |--server/ | |--db/ | |--auth/ | |--handlers | | |--spec/ | |--tests | | |--Node/Express server

Install

Global Installs

For developing: Eslint installed to run linter

$ npm install eslint -g

For testing: Mocha

$ npm install mocha -g

For building and deploying: Webpack

$ npm install webpack -g

For database access: Mongo

$ npm install mongodb -g

Local Install

Download all dependencies listed under package.json

$ npm install

To Run the Application

Initiate both Development and Production servers by running $ npm run devStart and $ npm run production in separate terminal windows

Fronend development changes are reflected immediately on http://localhost:8080 Server side API requests are routed through the webpack-dev-server proxy to http://localhost:3000

Testing

Before testing make sure to have both servers running then run npm run test

Contributing

We are happy to review and merge pull requests. Please see CONTRIBUTING if you'd like to add to our amazing project.

License

MIT

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 90.2%
  • CSS 9.0%
  • Other 0.8%