Compare commits
8 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| cd34f0db5c | |||
| ab9e7456fb | |||
| 90a4fc1a6a | |||
| 42fa9e27e7 | |||
| 0c462d0e6c | |||
| fce018d19b | |||
| 6717dbdef6 | |||
| 39c3e55bd5 |
@@ -1,6 +1,8 @@
|
||||
WEB_PORT=3000
|
||||
|
||||
DB_HOSTNAME=localhost
|
||||
DB_PORTNAME=3306
|
||||
|
||||
DB_DATABASE=template
|
||||
DB_USERNAME=template
|
||||
DB_PASSWORD=pikachu
|
||||
|
||||
@@ -7,7 +7,7 @@ The primary technology involved is:
|
||||
* React
|
||||
* Nodejs
|
||||
* MariaDB (with Sequelize)
|
||||
* Docker (with docker-compose)
|
||||
* Docker (with docker compose)
|
||||
|
||||
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.
|
||||
|
||||
@@ -31,7 +31,7 @@ A clean install is this easy:
|
||||
git clone https://github.com/krgamestudios/MERN-template.git
|
||||
cd MERN-template
|
||||
node configure-script.js
|
||||
docker-compose up --build
|
||||
docker compose up --build
|
||||
```
|
||||
|
||||
# Setup Development
|
||||
|
||||
@@ -18,7 +18,7 @@ const NewsEditor = props => {
|
||||
|
||||
//run once
|
||||
useEffect(() => {
|
||||
fetch(`${process.env.NEWS_URI}/news/metadata?limit=999`)
|
||||
fetch(`${process.env.NEWS_URI}/news/metadata?page_size=999`)
|
||||
.then(res => res.json())
|
||||
.then(json => {
|
||||
setArticles(json)
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import React, { useState, useEffect, createContext } from 'react';
|
||||
import decode from 'jwt-decode';
|
||||
import { jwtDecode } from 'jwt-decode';
|
||||
|
||||
export const TokenContext = createContext();
|
||||
|
||||
@@ -31,7 +31,7 @@ const TokenProvider = props => {
|
||||
let bearer = accessToken;
|
||||
|
||||
//if expired (10 minutes, normally)
|
||||
const expired = new Date(decode(accessToken).exp * 1000) < Date.now();
|
||||
const expired = new Date(jwtDecode(accessToken).exp) < Date.now() / 1000;
|
||||
|
||||
if (expired) {
|
||||
//BUGFIX: if logging out, just skip over the refresh token
|
||||
@@ -48,6 +48,9 @@ const TokenProvider = props => {
|
||||
//ping the auth server for a new access token
|
||||
const response = await fetch(`${process.env.AUTH_URI}/auth/token`, {
|
||||
method: 'POST',
|
||||
headers: {
|
||||
'Authorization': `Bearer ${bearer}`
|
||||
},
|
||||
credentials: 'include'
|
||||
});
|
||||
|
||||
@@ -79,13 +82,19 @@ const TokenProvider = props => {
|
||||
|
||||
//access the refreshed token via callback
|
||||
const tokenCallback = async (cb) => {
|
||||
//use this?
|
||||
let bearer = accessToken;
|
||||
|
||||
//if expired (10 minutes, normally)
|
||||
const expired = new Date(decode(accessToken).exp * 1000) < Date.now();
|
||||
const expired = new Date(jwtDecode(accessToken).exp) < Date.now() / 1000;
|
||||
|
||||
if (expired) {
|
||||
//ping the auth server for a new token
|
||||
const response = await fetch(`${process.env.AUTH_URI}/auth/token`, {
|
||||
method: 'POST',
|
||||
headers: {
|
||||
'Authorization': `Bearer ${bearer}`
|
||||
},
|
||||
credentials: 'include'
|
||||
});
|
||||
|
||||
@@ -110,7 +119,7 @@ const TokenProvider = props => {
|
||||
};
|
||||
|
||||
return (
|
||||
<TokenContext.Provider value={{ accessToken, setAccessToken, tokenFetch, tokenCallback, getPayload: () => decode(accessToken) }}>
|
||||
<TokenContext.Provider value={{ accessToken, setAccessToken, tokenFetch, tokenCallback, getPayload: () => jwtDecode(accessToken) }}>
|
||||
{props.children}
|
||||
</TokenContext.Provider>
|
||||
)
|
||||
|
||||
+122
-27
@@ -36,7 +36,7 @@ const question = (prompt, def = null) => {
|
||||
|
||||
Currently, all microservices are mandatory; you'll have to mess with the result
|
||||
and the source code if you wish to be more selective. Microservices currently
|
||||
impelented are:
|
||||
implemented are:
|
||||
|
||||
* auth-server
|
||||
* news-server
|
||||
@@ -49,7 +49,7 @@ See https://github.com/krgamestudios/MERN-template/wiki for help.
|
||||
//determine local computer address for mac user vs everyone else
|
||||
let macUser = '';
|
||||
while (macUser.toLowerCase() !== 'yes' && macUser.toLowerCase() !== 'no') {
|
||||
macUser = await question('Will the MERN Template be running locally on a MacOS system? (yes or no)', '');
|
||||
macUser = await question('Will the MERN-Template be running locally on a MacOS system? (yes or no, this only alters startup.sql)', '');
|
||||
}
|
||||
|
||||
const localAddress = macUser ? 'localhost' : '%';
|
||||
@@ -58,13 +58,48 @@ See https://github.com/krgamestudios/MERN-template/wiki for help.
|
||||
const projectName = await question('Project Name', 'template');
|
||||
const projectWebAddress = await question('Project Web Address', 'example.com');
|
||||
|
||||
let projectDBLocation = '';
|
||||
while (typeof projectDBLocation != 'string' || /^[le]/i.test(projectDBLocation[0]) == false) {
|
||||
projectDBLocation = await question('Project [l]ocal or [e]xternal database?');
|
||||
}
|
||||
|
||||
let projectDBHost = '';
|
||||
let projectDBPort = '';
|
||||
|
||||
if (/^[l]/i.test(projectDBLocation[0])) {
|
||||
projectDBHost = 'database';
|
||||
projectDBPort = '3306';
|
||||
}
|
||||
else {
|
||||
projectDBHost = await question('Project DB Host');
|
||||
projectDBPort = await question('Project DB Port', '3306');
|
||||
}
|
||||
|
||||
const projectDBUser = await question('Project DB Username', projectName);
|
||||
const projectDBPass = await question('Project DB Password', 'pikachu');
|
||||
|
||||
//news configuration
|
||||
const newsName = await question('News Name', 'news');
|
||||
const newsWebAddress = await question('News Web Address', `${newsName}.${projectWebAddress}`);
|
||||
const newsDBUser = await question('News DB Username', newsName);
|
||||
|
||||
let newsDBLocation = '';
|
||||
while (typeof newsDBLocation != 'string' || /^[le]/i.test(newsDBLocation[0]) == false) {
|
||||
newsDBLocation = await question('News [l]ocal or [e]xternal database?');
|
||||
}
|
||||
|
||||
let newsDBHost = '';
|
||||
let newsDBPort = '';
|
||||
|
||||
if (/^[l]/i.test(newsDBLocation[0])) {
|
||||
newsDBHost = 'database';
|
||||
newsDBPort = '3306';
|
||||
}
|
||||
else {
|
||||
newsDBHost = await question('News DB Host');
|
||||
newsDBPort = await question('News DB Port', '3306');
|
||||
}
|
||||
|
||||
const newsDBUser = await question('News DB Username', newsName);
|
||||
const newsDBPass = await question('News DB Password', 'venusaur');
|
||||
|
||||
//auth configuration
|
||||
@@ -72,7 +107,25 @@ See https://github.com/krgamestudios/MERN-template/wiki for help.
|
||||
const authWebAddress = await question('Auth Web Address', `${authName}.${projectWebAddress}`);
|
||||
const authPostValidationHookArray = await question('Auth Post Validation Hook Array', '');
|
||||
const authResetAddress = await question('Auth Reset Addr', `${projectWebAddress}/reset`);
|
||||
const authDBUser = await question('Auth DB Username', authName);
|
||||
|
||||
let authDBLocation = '';
|
||||
while (typeof authDBLocation != 'string' || /^[le]/i.test(authDBLocation[0]) == false) {
|
||||
authDBLocation = await question('Auth [l]ocal or [e]xternal database?');
|
||||
}
|
||||
|
||||
let authDBHost = '';
|
||||
let authDBPort = '';
|
||||
|
||||
if (/^[l]/i.test(authDBLocation[0])) {
|
||||
authDBHost = 'database';
|
||||
authDBPort = '3306';
|
||||
}
|
||||
else {
|
||||
authDBHost = await question('Auth DB Host');
|
||||
authDBPort = await question('Auth DB Port', '3306');
|
||||
}
|
||||
|
||||
const authDBUser = await question('Auth DB Username', authName);
|
||||
const authDBPass = await question('Auth DB Password', 'charizard');
|
||||
|
||||
const emailSMTP = await question('Email SMTP', 'smtp.example.com');
|
||||
@@ -83,7 +136,25 @@ See https://github.com/krgamestudios/MERN-template/wiki for help.
|
||||
//chat goes here
|
||||
const chatName = await question('Chat Name', 'chat');
|
||||
const chatWebAddress = await question('Chat Web Address', `${chatName}.${projectWebAddress}`);
|
||||
const chatDBUser = await question('Chat DB Username', chatName);
|
||||
|
||||
let chatDBLocation = '';
|
||||
while (typeof chatDBLocation != 'string' || /^[le]/i.test(chatDBLocation[0]) == false) {
|
||||
chatDBLocation = await question('Chat [l]ocal or [e]xternal database?');
|
||||
}
|
||||
|
||||
let chatDBHost = '';
|
||||
let chatDBPort = '';
|
||||
|
||||
if (/^[l]/i.test(chatDBLocation[0])) {
|
||||
chatDBHost = 'database';
|
||||
chatDBPort = '3306';
|
||||
}
|
||||
else {
|
||||
chatDBHost = await question('Chat DB Host');
|
||||
chatDBPort = await question('Chat DB Port', '3306');
|
||||
}
|
||||
|
||||
const chatDBUser = await question('Chat DB Username', chatName);
|
||||
const chatDBPass = await question('Chat DB Password', 'blastoise');
|
||||
|
||||
//database configuration
|
||||
@@ -99,11 +170,14 @@ See https://github.com/krgamestudios/MERN-template/wiki for help.
|
||||
|
||||
//MUST be at least 8 chars
|
||||
let tmpPass = '';
|
||||
let tmpHost = '';
|
||||
while (defaultUser && tmpPass.length < 8) {
|
||||
console.log('--All passwords must be at least 8 characters long--');
|
||||
tmpPass = await question('Default Admin Pass', '');
|
||||
tmpHost = await question('Default Admin Host', '');
|
||||
}
|
||||
const defaultPass = tmpPass;
|
||||
const defaultHost = tmpHost;
|
||||
|
||||
if (defaultUser) {
|
||||
console.log(`Default user email will be: ${defaultUser}@${authWebAddress}`);
|
||||
@@ -113,18 +187,17 @@ See https://github.com/krgamestudios/MERN-template/wiki for help.
|
||||
const supportEmail = await question('Support Email', emailUser);
|
||||
|
||||
//misc. configuration
|
||||
const projectPort = 3000;
|
||||
const newsPort = 3100;
|
||||
const authPort = 3200;
|
||||
const chatPort = 3300;
|
||||
const projectPort = '3000';
|
||||
const newsPort = '3100';
|
||||
const authPort = '3200';
|
||||
const chatPort = '3300';
|
||||
|
||||
const ymlfile = `
|
||||
version: "3.8"
|
||||
services:
|
||||
${projectName}:
|
||||
build: .
|
||||
ports:
|
||||
- "${projectPort}"
|
||||
- ${projectPort}
|
||||
labels:
|
||||
- traefik.enable=true
|
||||
- traefik.http.routers.${projectName}router.rule=Host(\`${projectWebAddress}\`)
|
||||
@@ -134,7 +207,8 @@ services:
|
||||
- traefik.http.services.${projectName}service.loadbalancer.server.port=${projectPort}
|
||||
environment:
|
||||
- WEB_PORT=${projectPort}
|
||||
- DB_HOSTNAME=database
|
||||
- DB_HOSTNAME=${projectDBHost}
|
||||
- DB_PORTNAME=${projectDBPort}
|
||||
- DB_DATABASE=${projectName}
|
||||
- DB_USERNAME=${projectDBUser}
|
||||
- DB_PASSWORD=${projectDBPass}
|
||||
@@ -143,10 +217,13 @@ services:
|
||||
- AUTH_URI=https://${authWebAddress}
|
||||
- CHAT_URI=https://${chatWebAddress}
|
||||
- SECRET_ACCESS=${accessToken}
|
||||
volumes:
|
||||
- /etc/timezone:/etc/timezone:ro
|
||||
- /etc/localtime:/etc/localtime:ro
|
||||
networks:
|
||||
- app-network
|
||||
depends_on:
|
||||
- database
|
||||
depends_on:${ projectDBHost != 'database' ? '' : `
|
||||
- database`}
|
||||
- traefik
|
||||
|
||||
${newsName}:
|
||||
@@ -162,17 +239,21 @@ services:
|
||||
- traefik.http.services.${newsName}service.loadbalancer.server.port=${newsPort}
|
||||
environment:
|
||||
- WEB_PORT=${newsPort}
|
||||
- DB_HOSTNAME=database
|
||||
- DB_HOSTNAME=${newsDBHost}
|
||||
- DB_PORTNAME=${newsDBPort}
|
||||
- DB_DATABASE=${newsName}
|
||||
- DB_USERNAME=${newsDBUser}
|
||||
- DB_PASSWORD=${newsDBPass}
|
||||
- DB_TIMEZONE=${dbTimeZone}
|
||||
- QUERY_LIMIT=10
|
||||
- PAGE_SIZE=10
|
||||
- SECRET_ACCESS=${accessToken}
|
||||
volumes:
|
||||
- /etc/timezone:/etc/timezone:ro
|
||||
- /etc/localtime:/etc/localtime:ro
|
||||
networks:
|
||||
- app-network
|
||||
depends_on:
|
||||
- database
|
||||
depends_on:${ newsDBHost != 'database' ? '' : `
|
||||
- database`}
|
||||
- traefik
|
||||
|
||||
${authName}:
|
||||
@@ -192,7 +273,8 @@ services:
|
||||
- HOOK_POST_VALIDATION_ARRAY=${authPostValidationHookArray}
|
||||
- WEB_RESET_ADDRESS=${authResetAddress}
|
||||
- WEB_PORT=${authPort}
|
||||
- DB_HOSTNAME=database
|
||||
- DB_HOSTNAME=${authDBHost}
|
||||
- DB_PORTNAME=${authDBPort}
|
||||
- DB_DATABASE=${authName}
|
||||
- DB_USERNAME=${authDBUser}
|
||||
- DB_PASSWORD=${authDBPass}
|
||||
@@ -202,13 +284,17 @@ services:
|
||||
- MAIL_PASSWORD=${emailPass}
|
||||
- MAIL_PHYSICAL=${emailPhysical}
|
||||
- ADMIN_DEFAULT_USERNAME=${defaultUser}
|
||||
- ADMIN_DEFAULT_HOSTNAME=${defaultHost}
|
||||
- ADMIN_DEFAULT_PASSWORD=${defaultPass}
|
||||
- SECRET_ACCESS=${accessToken}
|
||||
- SECRET_REFRESH=${refreshToken}
|
||||
volumes:
|
||||
- /etc/timezone:/etc/timezone:ro
|
||||
- /etc/localtime:/etc/localtime:ro
|
||||
networks:
|
||||
- app-network
|
||||
depends_on:
|
||||
- database
|
||||
depends_on:${ authDBHost != 'database' ? '' : `
|
||||
- database`}
|
||||
- traefik
|
||||
|
||||
${chatName}:
|
||||
@@ -224,18 +310,23 @@ services:
|
||||
- traefik.http.services.${chatName}service.loadbalancer.server.port=${chatPort}
|
||||
environment:
|
||||
- WEB_PORT=${chatPort}
|
||||
- DB_HOSTNAME=database
|
||||
- DB_HOSTNAME=${chatDBHost}
|
||||
- DB_PORTNAME=${chatDBPort}
|
||||
- DB_DATABASE=${chatName}
|
||||
- DB_USERNAME=${chatDBUser}
|
||||
- DB_PASSWORD=${chatDBPass}
|
||||
- DB_TIMEZONE=${dbTimeZone}
|
||||
- SECRET_ACCESS=${accessToken}
|
||||
volumes:
|
||||
- /etc/timezone:/etc/timezone:ro
|
||||
- /etc/localtime:/etc/localtime:ro
|
||||
networks:
|
||||
- app-network
|
||||
depends_on:
|
||||
- database
|
||||
depends_on:${ chatDBHost != 'database' ? '' : `
|
||||
- database`}
|
||||
- traefik
|
||||
|
||||
${ [projectDBHost, newsDBHost, authDBHost, chatDBHost].some(x => x == "database") == false ? '' : `
|
||||
database:
|
||||
image: mariadb
|
||||
restart: always
|
||||
@@ -244,11 +335,13 @@ services:
|
||||
volumes:
|
||||
- ./mysql:/var/lib/mysql
|
||||
- ./startup.sql:/docker-entrypoint-initdb.d/startup.sql:ro
|
||||
- /etc/timezone:/etc/timezone:ro
|
||||
- /etc/localtime:/etc/localtime:ro
|
||||
networks:
|
||||
- app-network
|
||||
|
||||
`}
|
||||
traefik:
|
||||
image: traefik:v2.4
|
||||
image: traefik:latest
|
||||
container_name: traefik
|
||||
command:
|
||||
- --log.level=ERROR
|
||||
@@ -269,6 +362,8 @@ services:
|
||||
volumes:
|
||||
- ./letsencrypt:/letsencrypt
|
||||
- /var/run/docker.sock:/var/run/docker.sock:ro
|
||||
- /etc/timezone:/etc/timezone:ro
|
||||
- /etc/localtime:/etc/localtime:ro
|
||||
networks:
|
||||
- app-network
|
||||
|
||||
@@ -278,7 +373,7 @@ networks:
|
||||
`;
|
||||
|
||||
const dockerfile = `
|
||||
FROM node:21-bookworm-slim
|
||||
FROM node:22-bookworm-slim
|
||||
WORKDIR "/app"
|
||||
COPY . /app
|
||||
RUN mkdir /app/public
|
||||
|
||||
Generated
+1532
-969
File diff suppressed because it is too large
Load Diff
+22
-22
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "mern-template",
|
||||
"version": "1.5.0",
|
||||
"version": "1.5.1",
|
||||
"description": "A website template using the MERN stack.",
|
||||
"main": "server/server.js",
|
||||
"scripts": {
|
||||
@@ -21,40 +21,40 @@
|
||||
"url": "git+https://github.com/KRGameStudios/MERN-template.git"
|
||||
},
|
||||
"author": "Kayne Ruse",
|
||||
"license": "ISC",
|
||||
"license": "Zlib",
|
||||
"bugs": {
|
||||
"url": "https://github.com/KRGameStudios/MERN-template/issues"
|
||||
},
|
||||
"homepage": "https://github.com/KRGameStudios/MERN-template#readme",
|
||||
"dependencies": {
|
||||
"@babel/core": "^7.23.6",
|
||||
"@babel/preset-env": "^7.23.6",
|
||||
"@babel/preset-react": "^7.23.3",
|
||||
"@babel/core": "^7.24.5",
|
||||
"@babel/preset-env": "^7.24.5",
|
||||
"@babel/preset-react": "^7.24.1",
|
||||
"babel-loader": "^9.1.3",
|
||||
"clean-webpack-plugin": "^4.0.0",
|
||||
"compression-webpack-plugin": "^10.0.0",
|
||||
"concurrently": "^7.6.0",
|
||||
"css-loader": "^6.8.1",
|
||||
"compression-webpack-plugin": "^11.1.0",
|
||||
"concurrently": "^8.2.2",
|
||||
"css-loader": "^7.1.1",
|
||||
"dateformat": "^5.0.3",
|
||||
"dotenv": "^16.3.1",
|
||||
"express": "^4.18.2",
|
||||
"dotenv": "^16.4.5",
|
||||
"express": "^4.19.2",
|
||||
"html-webpack-plugin": "^5.6.0",
|
||||
"jwt-decode": "^3.1.2",
|
||||
"mariadb": "^3.2.3",
|
||||
"react": "^18.2.0",
|
||||
"react-dom": "^18.2.0",
|
||||
"jwt-decode": "^4.0.0",
|
||||
"mariadb": "^3.3.0",
|
||||
"react": "^18.3.1",
|
||||
"react-dom": "^18.3.1",
|
||||
"react-router": "^6.3.0",
|
||||
"react-router-dom": "^6.21.1",
|
||||
"react-router-dom": "^6.23.0",
|
||||
"react-select": "^5.8.0",
|
||||
"sequelize": "^6.35.2",
|
||||
"socket.io-client": "^4.7.2",
|
||||
"style-loader": "^3.3.3",
|
||||
"webpack": "^5.89.0",
|
||||
"webpack-bundle-analyzer": "^4.10.1",
|
||||
"sequelize": "^6.37.3",
|
||||
"socket.io-client": "^4.7.5",
|
||||
"style-loader": "^4.0.0",
|
||||
"webpack": "^5.91.0",
|
||||
"webpack-bundle-analyzer": "^4.10.2",
|
||||
"webpack-cli": "^5.1.4"
|
||||
},
|
||||
"devDependencies": {
|
||||
"nodemon": "^3.0.2",
|
||||
"webpack-dev-server": "^4.15.1"
|
||||
"nodemon": "^3.1.0",
|
||||
"webpack-dev-server": "^5.0.4"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2,11 +2,10 @@ const Sequelize = require('sequelize');
|
||||
|
||||
const sequelize = new Sequelize(process.env.DB_DATABASE, process.env.DB_USERNAME, process.env.DB_PASSWORD, {
|
||||
host: process.env.DB_HOSTNAME,
|
||||
port: process.env.DB_PORTNAME,
|
||||
dialect: 'mariadb',
|
||||
timezone: process.env.DB_TIMEZONE,
|
||||
logging: process.env.DB_LOGGING ? console.log : false
|
||||
});
|
||||
|
||||
sequelize.sync();
|
||||
|
||||
module.exports = sequelize;
|
||||
module.exports = sequelize;
|
||||
@@ -42,4 +42,5 @@ app.get('*', (req, res) => {
|
||||
server.listen(process.env.WEB_PORT || 3000, async (err) => {
|
||||
await database.sync();
|
||||
console.log(`listening to localhost:${process.env.WEB_PORT || 3000}`);
|
||||
console.log(`database located at ${process.env.DB_HOSTNAME || '<default>'}:${process.env.DB_PORTNAME || '<default>'}`);
|
||||
});
|
||||
|
||||
@@ -1,10 +1,5 @@
|
||||
#This file only needs to be run once, during initial development setup
|
||||
#This file isnt needed for actual deployment
|
||||
#use this while debugging
|
||||
CREATE DATABASE template;
|
||||
CREATE USER 'template'@'%' IDENTIFIED BY 'pikachu';
|
||||
GRANT ALL PRIVILEGES ON template.* TO 'template'@'%';
|
||||
|
||||
#Create the development database
|
||||
CREATE DATABASE IF NOT EXISTS template;
|
||||
USE template;
|
||||
|
||||
#Create the database user
|
||||
CREATE USER IF NOT EXISTS 'template'@'%' IDENTIFIED BY 'pikachu';
|
||||
GRANT ALL PRIVILEGES ON template.* TO 'template'@'%';
|
||||
+5
-4
@@ -91,11 +91,12 @@ module.exports = ({ production, development, local, analyze }) => {
|
||||
}
|
||||
},
|
||||
|
||||
proxy: {
|
||||
'/api': {
|
||||
target: 'http://localhost:3000'
|
||||
proxy: [
|
||||
{
|
||||
context: ['/api'],
|
||||
target: 'http://localhost:3000',
|
||||
}
|
||||
},
|
||||
],
|
||||
|
||||
static: '/public',
|
||||
|
||||
|
||||
Reference in New Issue
Block a user