Bumped version number

README.md

@@ -1,91 +1,92 @@
-# MERN-template
+# MERN-template
-
+
-A website template using the MERN stack. The primary technology involved is:
+A website template using the MERN stack. It is geared towards Persistent Browser Based Games (think neopets), but is flexible enough for a number of different uses.
-
+
-* React
+The primary technology involved is:
-* Nodejs
+
-* MariaDB (with Sequelize)
+* React
-* Docker (with docker-compose)
+* Nodejs
-
+* MariaDB (with Sequelize)
-This template is designed to support the development of persistent browser based games (PBBGs), but it, and it's component microservices, can be used elsewhere.
+* Docker (with docker-compose)
-
+
-This template is released under the zlib license (see LICENSE).
+This template is designed to support the development of persistent browser based games (PBBGs), but it, and it's component microservices, can be used elsewhere.
-
+
-See the [github wiki](https://github.com/krgamestudios/MERN-template/wiki) for full documentation.
+This template is released under the zlib license (see LICENSE).
-
+
-# Microservices
+See the [github wiki](https://github.com/krgamestudios/MERN-template/wiki) for full documentation.
-
+
-There are external components to this template referred to as "microservices". These can be omitted entirely by simply removing the React components that access them. These are also available via [docker hub](https://hub.docker.com/u/krgamestudios).
+# Microservices
-
+
-* News Server: https://github.com/krgamestudios/news-server
+There are external components to this template referred to as "microservices". These can be omitted entirely by simply removing the React components that access them. These are also available via [docker hub](https://hub.docker.com/u/krgamestudios).
-* Auth Server: https://github.com/krgamestudios/auth-server
+
-* Chat Server: https://github.com/krgamestudios/chat-server
+* News Server: https://github.com/krgamestudios/news-server
-
+* Auth Server: https://github.com/krgamestudios/auth-server
-# Setup Deployment
+* Chat Server: https://github.com/krgamestudios/chat-server
-
+
-A clean install is this easy:
+# Setup Deployment
-
+
-```
+A clean install is this easy:
-git clone https://github.com/krgamestudios/MERN-template.git
+
-cd MERN-template
+```
-npm install
+git clone https://github.com/krgamestudios/MERN-template.git
-node configure-script.js
+cd MERN-template
-docker-compose up --build
+node configure-script.js
-```
+docker-compose up --build
-
+```
-# Setup Development
+
-
+# Setup Development
-To set up this template in development mode:
+
-
+To set up this template in development mode:
-1. Ensure mariadb is running in your development environment
+
-2. Run `mariadb sql/create_database.sql` as the root user
+1. Ensure mariadb is running in your development environment
-3. Run `npm install`
+2. Run `mariadb sql/create_database.sql` as the root user
-4. Run `cp .envdev .env` and enter your details into the `.env` file
+3. Run `npm install`
-5. Execute `npm run dev`
+4. Run `cp .envdev .env` and enter your details into the `.env` file
-6. Navigate to `http://localhost:3001` in your web browser
+5. Execute `npm run dev`
-
+6. Navigate to `http://localhost:3001` in your web browser
-# Features List
+
-
+# Features List
-- Mainly one language across the codebase (JavaScript)
+
-- Full documentation
+- Mainly one language across the codebase (JavaScript)
-	- Setup tutorial
+- Full documentation
-- Fully Featured Account System (as a microservice)
+	- Setup tutorial
-	- Email validation
+- Fully Featured Account System (as a microservice)
-	- Logging in and out
+	- Email validation
-	- Account deletion
+	- Logging in and out
-	- Password management
+	- Account deletion
-	- JSON web token authentication
+	- Password management
-- Fully Featured News Blog (as a microservice)
+	- JSON web token authentication
-	- Publish, edit or delete articles as needed
+- Fully Featured News Blog (as a microservice)
-	- Secured via admin panel
+	- Publish, edit or delete articles as needed
-- Fully Featured Chat System (as a microservice)
+	- Secured via admin panel
-	- Available when logged in
+- Fully Featured Chat System (as a microservice)
-	- Chat logs saved to the database
+	- Available when logged in
-	- Room-based chat (type `/room name` to access a specific room)
+	- Chat logs saved to the database
-- Moderation tools
+	- Room-based chat (type `/room name` to access a specific room)
-	- Permanently banning users
+- Moderation tools
-	- Chat-muting users for a time period
+	- Permanently banning users
-	- Users reporting offensive chat-content
+	- Chat-muting users for a time period
-- Easy To Use Configuration Script
+	- Users reporting offensive chat-content
-	- Sets up everything via docker
+- Easy To Use Configuration Script
-	- A default admin account (if desired)
+	- Sets up everything via docker
-
+	- A default admin account (if desired)
-# Coming Soon
+
-
+# Coming Soon
-- Full documentation
+
-	- Modding tutorials
+- Full documentation
-
+	- Modding tutorials
-# Coming Eventually
+
-
+# Coming Eventually
-- Fully Featured News Blog (as a microservice)
+
-	- Restore deleted articles
+- Fully Featured News Blog (as a microservice)
-	- Undo edits
+	- Restore deleted articles
-- Fully Featured Chat System (as a microservice)
+	- Undo edits
-	- Custom emoji
+- Fully Featured Chat System (as a microservice)
-	- Private messaging
+	- Custom emoji
-	- Broadcasting to all channels
+	- Private messaging
-	- Badges next to usernames
+	- Broadcasting to all channels
-- Better compression for client files
+	- Badges next to usernames
-- Backend for leaderboards (modding tutorial?)
+- Better compression for client files
-- Backend for energy systems (modding tutorial?)
+- Backend for leaderboards (modding tutorial?)
-- Backend for items, shops, trading and currency
+- Backend for energy systems (modding tutorial?)
+- Backend for items, shops, trading and currency

client/components/pages/account.jsx

@@ -37,7 +37,7 @@ const Account = props => {
 	return (
 		<div className='page'>
 			<h1 className='centered'>Account</h1>
-			<form className='constricted' onSubmit={async evt => {
+			<form className='constrained' onSubmit={async evt => {
 				evt.preventDefault();
 				const [err] = await update(passwordRef.current.value, retypeRef.current.value, contactRef.current.checked, authTokens.tokenFetch);
 
@@ -69,7 +69,7 @@ const Account = props => {
 				<button type='submit'>Update Information</button>
 			</form>
 
-			<DeleteAccount className='constricted' />
+			<DeleteAccount className='constrained' />
 		</div>
 	);
 };

client/components/pages/login.jsx

@@ -21,7 +21,7 @@ const LogIn = props => {
 	return (
 		<div className='page'>
 			<h1 className='centered'>Login</h1>
-			<form className='constricted' onSubmit={
+			<form className='constrained' onSubmit={
 				async evt => {
 					//on submit
 					evt.preventDefault();

client/components/pages/recover.jsx

@@ -22,7 +22,7 @@ const Recover = props => {
 	return (
 		<div className='page'>
 			<h1 className='centered'>Recover Password</h1>
-			<form className='constricted' onSubmit={
+			<form className='constrained panel' onSubmit={
 				async evt => { //on submit
 					recoverRef.current.disabled = true;
 					evt.preventDefault();

client/components/pages/reset.jsx

@@ -25,9 +25,9 @@ const Reset = props => {
 	return (
 		<div className='page'>
 			<h1 className='centered'>Reset Password</h1>
-			<form className='constricted' onSubmit={async evt => {
+			<form className='constrained panel' onSubmit={async evt => {
 				evt.preventDefault();
-				const [err] = await update(passwordRef.current.value, retypeRef.current.value, query);
+				const [err, redirect] = await update(passwordRef.current.value, retypeRef.current.value, query);
 
 				if (err) {
 					alert(err);
@@ -43,12 +43,12 @@ const Reset = props => {
 			}}>
 				<div>
 					<div>
-						<label htmlFor='password'>Enter New Password:</label> 
+						<label htmlFor='password'>Enter New Password:</label>
 						<input type='password' name='password' ref={passwordRef} />
 					</div>
 
 					<div>
-						<label htmlFor='retype'>Retype New Password:</label> 
+						<label htmlFor='retype'>Retype New Password:</label>
 						<input type='password' name='retype' ref={retypeRef} />
 					</div>
 				</div>
@@ -82,7 +82,7 @@ const update = async (password, retype, query) => {
 	if (!result.ok) {
 		return [`${await result.status}: ${await result.text()}`];
 	} else {
-		return [null];
+		return [null, true];
 	}
 }
 

client/components/pages/signup.jsx

@@ -27,7 +27,7 @@ const SignUp = props => {
 	return (
 		<div className='page'>
 			<h1 className='centered'>Signup</h1>
-			<form className='constricted' onSubmit={
+			<form className='constrained' onSubmit={
 				async evt => { //on submit
 					signupRef.current.disabled = true;
 					evt.preventDefault();

client/components/panels/markdown.jsx

@@ -28,7 +28,7 @@ const Markdown = props => {
 	}
 
 	return (
-		<ReactMarkdown rehypePlugins={[rehypeRaw]} escapeHtml={false} props={{...props}}>{contentHook}</ReactMarkdown>
+		<ReactMarkdown rehypePlugins={[rehypeRaw]} props={{...props}}>{contentHook}</ReactMarkdown>
 	);
 };
 

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "mern-template",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "mern-template",
-      "version": "1.0.2",
+      "version": "1.0.4",
       "license": "ISC",
       "dependencies": {
         "@babel/core": "^7.14.8",

package.json

@@ -1,61 +1,61 @@
-{
+{
-  "name": "mern-template",
+  "name": "mern-template",
-  "version": "1.0.2",
+  "version": "1.0.4",
-  "description": "A website template using the MERN stack.",
+  "description": "A website template using the MERN stack.",
-  "main": "server/server.js",
+  "main": "server/server.js",
-  "scripts": {
+  "scripts": {
-    "start": "npm run build && node server/server.js",
+    "start": "npm run build && node server/server.js",
-    "build": "npm run build:server && npm run build:client",
+    "build": "npm run build:server && npm run build:client",
-    "build:server": "exit 0",
+    "build:server": "exit 0",
-    "build:client": "webpack --env=production --config webpack.config.js",
+    "build:client": "webpack --env=production --config webpack.config.js",
-    "dev": "concurrently npm:watch:server npm:watch:client",
+    "dev": "concurrently npm:watch:server npm:watch:client",
-    "watch:server": "nodemon ./* --ext js,jsx,json --ignore 'node_modules/*'",
+    "watch:server": "nodemon ./* --ext js,jsx,json --ignore 'node_modules/*'",
-    "watch:client": "webpack serve --env=development --config webpack.config.js",
+    "watch:client": "webpack serve --env=development --config webpack.config.js",
-    "analyzer": "webpack --env=production --analyzer --config webpack.config.js"
+    "analyzer": "webpack --env=production --analyzer --config webpack.config.js"
-  },
+  },
-  "repository": {
+  "repository": {
-    "type": "git",
+    "type": "git",
-    "url": "git+https://github.com/KRGameStudios/MERN-template.git"
+    "url": "git+https://github.com/KRGameStudios/MERN-template.git"
-  },
+  },
-  "author": "Kayne Ruse",
+  "author": "Kayne Ruse",
-  "license": "ISC",
+  "license": "ISC",
-  "bugs": {
+  "bugs": {
-    "url": "https://github.com/KRGameStudios/MERN-template/issues"
+    "url": "https://github.com/KRGameStudios/MERN-template/issues"
-  },
+  },
-  "homepage": "https://github.com/KRGameStudios/MERN-template#readme",
+  "homepage": "https://github.com/KRGameStudios/MERN-template#readme",
-  "dependencies": {
+  "dependencies": {
-    "@babel/core": "^7.14.8",
+    "@babel/core": "^7.14.8",
-    "@babel/preset-env": "^7.14.8",
+    "@babel/preset-env": "^7.14.8",
-    "@babel/preset-react": "^7.14.5",
+    "@babel/preset-react": "^7.14.5",
-    "@loadable/component": "^5.15.0",
+    "@loadable/component": "^5.15.0",
-    "babel-loader": "^8.2.2",
+    "babel-loader": "^8.2.2",
-    "clean-webpack-plugin": "^3.0.0",
+    "clean-webpack-plugin": "^3.0.0",
-    "concurrently": "^6.2.0",
+    "concurrently": "^6.2.0",
-    "css-loader": "^6.2.0",
+    "css-loader": "^6.2.0",
-    "dateformat": "^4.5.1",
+    "dateformat": "^4.5.1",
-    "dotenv": "^10.0.0",
+    "dotenv": "^10.0.0",
-    "express": "^4.17.1",
+    "express": "^4.17.1",
-    "html-webpack-plugin": "^5.3.2",
+    "html-webpack-plugin": "^5.3.2",
-    "jwt-decode": "^3.1.2",
+    "jwt-decode": "^3.1.2",
-    "mariadb": "^2.5.4",
+    "mariadb": "^2.5.4",
-    "query-string": "^7.0.1",
+    "query-string": "^7.0.1",
-    "raw-loader": "^4.0.2",
+    "raw-loader": "^4.0.2",
-    "react": "^17.0.2",
+    "react": "^17.0.2",
-    "react-dom": "^17.0.2",
+    "react-dom": "^17.0.2",
-    "react-dropdown-select": "^4.7.4",
+    "react-dropdown-select": "^4.7.4",
-    "react-markdown": "^6.0.2",
+    "react-markdown": "^6.0.2",
-    "react-router": "^5.2.0",
+    "react-router": "^5.2.0",
-    "react-router-dom": "^5.2.0",
+    "react-router-dom": "^5.2.0",
-    "rehype-raw": "^5.1.0",
+    "rehype-raw": "^5.1.0",
-    "sequelize": "^6.6.5",
+    "sequelize": "^6.6.5",
-    "socket.io-client": "^4.1.3",
+    "socket.io-client": "^4.1.3",
-    "style-loader": "^3.2.1",
+    "style-loader": "^3.2.1",
-    "webpack": "^5.46.0",
+    "webpack": "^5.46.0",
-    "webpack-bundle-analyzer": "^4.4.2",
+    "webpack-bundle-analyzer": "^4.4.2",
-    "webpack-cli": "^4.7.2"
+    "webpack-cli": "^4.7.2"
-  },
+  },
-  "devDependencies": {
+  "devDependencies": {
-    "nodemon": "^2.0.12",
+    "nodemon": "^2.0.12",
-    "webpack-dev-server": "^3.11.2"
+    "webpack-dev-server": "^3.11.2"
-  }
+  }
-}
+}