Web application to provide a fun environment to master regular expression syntax and usage.
- User can signup and have their progress saved / or you may target frontend only and save user progress to local storage
- User can “practice” to learn the concepts in a level
- User can “test” to complete a level and move to the next
- User can “fight” and compete against an AI opponent, matched to challenge at the user’s approximate level
- User rises in level as they complete sections
- User gains badges as they complete sections
- Cheat Sheet is available for reviewing concepts
- Implement profile allowing the user to outfit their avatar with items they earn via practicing, testing, and fighting.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Things you need to install to run the app:
- Node
- MongoDB
Get the repository
git clone https://github.com/roxroy/regex-dojo.git
cd regex-dojo
npm install
Make a copy of env.example
as .env
cp env.example .env
Update the corresponding keys and credentials.
In a new terminal, go to the project folder, create a data folder and start mongo
mkdir data
mongod --dbpath=./data
In a new terminal, go to the project folder (folder with server.js) and run the following:
npm run start
Access the app through the browser, http://localhost:3000.
Release build is optimized for deployment to Heroku and MLab. Don't forget to set environment variables on Heroku from .env.
- MongoDB - NoSQL database
- Express.js - Web application framework
- Node.js - Platform for network applications
Please open any issues that you encounter on the GitHub repo issue page.
- Roxroy - roxroy
- Hat tip to anyone who's code was used
- Readme template used