Boilerplate for MERN stack development, prepared for production.
Highlights
- Docker containers
- Using HTTP/2
- Redis for sessions
- Folder by Feature structure
- Minimal Material UI v4 design
- Built-in dark theme switch
- Built-in React routing, Redux
- Built-in local authentication with Passport
- Built-in Google and GitHub authentication
- Built-in PayPal payment (smart buttons)
- Built-in Socket.IO connection
- EJS for rendering
- Handling database with Mongoose
- Email sending by NodeMailer
- Winston for logging
- Testing with Mocha and Chai
- Clean code with ESLint, JavaScript Standard Style
- Webpack built production server
- Using PM2 (cluster mode) for production
These are the planned updates of the project.
- Nginx server
PayPal paymentGoogle loginGitHub loginDark theme switchMaterial UI v4
- Clone the repository
- Install dependencies
- Set env variables
- Add SSL files
- Create database
- Set up PayPal, Google, GitHub (optional)
Clone the repository
git clone https://github.com/tamasszoke/mern-boilerplate.git
Install dependencies
Run npm install at server folder
Run npm install at client folder
Set env variables - Client
Create .env.development and .env.production files inside client/ folder.
Use port 3002 for development and port 80 for production.
Example (include all of these):
HOST=0.0.0.0
PORT=3002
REACT_APP_HOST=localhost
REACT_APP_PORT=3001
SKIP_PREFLIGHT_CHECK=true
CHOKIDAR_USEPOLLING=true
Located at client/.env.development.
Note: if you change the ports change them in the dockerfiles too (root, server).
Set env variables - Server
Create test.config.env, development.config.env and production.config.env files inside server/.env/ folder.
Use port 3001 for test, development and port 80 for production.
Example (include all of these):
IP=0.0.0.0
HOST=localhost
PORT=3001
CLIENT_HOST=localhost
CLIENT_PORT=3002
REDIS_URL=redis://redis:6379
SSL_KEY=[SSL_KEY_FILE_NAME]
SSL_CRT=[SSL_CRT_FILE_NAME]
DB_HOST=[MONGOLAB_DB_URL]
DB_USER=[MONGOLAB_DB_USERNAME]
DB_PASS=[MONGOLAB_DB_PASSWORD]
EMAIL_ADDRESS=[GMAIL_ADDRESS]
EMAIL_PASS=[GMAIL_PASSWORD]
PAYPAL_CLIENT_ID=[PAYPAL_ID]
PAYPAL_CLIENT_SECRET=[PAYPAL_SECRET]
GOOGLE_CLIENT_ID=[GOOGLE_ID]
GOOGLE_CLIENT_SECRET=[GOOGLE_SECRET]
GITHUB_CLIENT_ID=[GITHUB_ID]
GITHUB_CLIENT_SECRET=[GITHUB_SECRET]
Located at server/.env/development.config.env.
Note: if you change the ports change them in the dockerfiles too (root, server).
Add SSL files
Put your (for example) crt.txt and key.txt files inside server/ssl/ folder.
Tip: create them online for free at ZeroSSL
Create database
Create MongoDB with a collection called users.
I've used the free service provided by mLab.
Set up PayPal payment
- Create an account at PayPal Developer.
- Create an app, copy the client
IDandSecretto the.envfiles. - Create a sandbox account, so you can test the payment.
Set up Google authentication
- Create an account at Google Developer Console.
- Create an API Console project and client ID. Use Web browser as client type and
https://localhost/api/auth/login/google/callbackas callback url. - Copy the client
IDandSecretto the.envfiles.
Set up GitHub authentication
- Create a GitHub account.
- Register a new OAuth application at GitHub Developer.
- Copy the client
IDandSecretto the.envfiles.
Note: use the following commands at the root folder.
Development
- Start
docker-compose -f docker-compose.development.yml up - Go to
https://localhost:3001in browser for server - Go to
http://localhost:3002in browser for client
Production
- Run
npm run build - Start
docker-compose -f docker-compose.production.yml up -d - Go to
https://localhost:80in browser
Note: run npm rebuild node-sass inside the client container if asked.
Using separated docker-compose files for development and production.
Development
Start: docker-compose -f docker-compose.development.yml up
Stop: docker-compose -f docker-compose.development.yml down
Production
Start: docker-compose -f docker-compose.production.yml up
Stop: docker-compose -f docker-compose.production.yml down
You have to set the environment you use in your scripts at server/package.json:
"test": "set NODE_ENV=test&& mocha --exit --reporter spec \"src/*/*.test.js\"",
"dev": "set NODE_ENV=development&& nodemon app.js -L --exec \"npm run test && npm run lint && node\"",
"build": "set NODE_ENV=production&& webpack --config webpack.config.js",
Just overwrite the test, dev, build lines with the above.
Development
- Start
npm run dev(ordev:clientanddev:server) - Go to
https://localhost:3001(server) - Go to
http://localhost:3002(client)
Production
- Run
npm run build - Start
npm start - Go to
https://localhost:80
Note: you may need to install nodemon: npm install nodemon -g
If you prefer not to use docker, you can use the following scripts from the root folder:
npm run dev
To use this command, you should install concurrently.
It's prepared, just run npm install under the root folder.
npm run dev:client
Runs the react client in development mode.
The browser will lint, reload if you make edits.
npm run dev:server
Runs the node server in development mode.
The server will test, lint and reload if you make edits.
npm run build
Builds the complete application for production to the build folder.
npm start
Runs the app in production mode with PM2 (cluster mode).
npm stop
Stops the application instances in PM2.
npm run delete
Removes the application instances from PM2.
| Name | Version |
|---|---|
| concurrently | ^4.1.0 |
| Name | Version |
|---|---|
| @material-ui/core | ^4.4.2 |
| @material-ui/icons | ^4.4.1 |
| @material-ui/styles | ^4.4.1 |
| animate.css | ^3.7.2 |
| axios | ^0.19.0 |
| node-sass | ^4.12.0 |
| react | ^16.9.0 |
| react-dom | ^16.9.0 |
| react-github-btn | ^1.0.6 |
| react-material-ui-form-validator | ^2.0.9 |
| react-notifications-component | ^2.0.7 |
| react-redux | ^7.1.1 |
| react-router-dom | ^5.0.1 |
| react-scripts | 3.1.1 |
| redux | ^4.0.4 |
| redux-persist | ^6.0.0 |
| socket.io-client | ^2.2.0 |
| Name | Version |
|---|---|
| @paypal/checkout-server-sdk | ^1.0.1 |
| body-parser | ^1.17.1 |
| connect-redis | ^3.4.0 |
| cookie-parser | ^1.4.3 |
| cors | ^2.8.5 |
| dotenv | ^6.2.0 |
| ejs | ^2.5.6 |
| express | ^4.15.2 |
| express-rate-limit | ^3.4.0 |
| express-session | ^1.15.6 |
| helmet | ^3.12.1 |
| mongoose | 5.1.3 |
| nodemailer | ^4.6.5 |
| nodemailer-smtp-transport | ^2.7.4 |
| passport | ^0.4.0 |
| passport-github2 | ^0.1.12 |
| passport-google-oauth20 | ^2.0.0 |
| passport-local | ^1.0.0 |
| path | ^0.12.7 |
| rate-limit-redis | ^1.6.0 |
| request | ^2.81.0 |
| socket.io | ^2.1.1 |
| spdy | ^4.0.0 |
| validator | ^10.10.0 |
| webpack-node-externals | ^1.7.2 |
| winston | 3.0.0-rc6 |
| Name | Version |
|---|---|
| chai | 4.1.2 |
| copy-webpack-plugin | ^5.0.1 |
| eslint | ^5.12.1 |
| eslint-config-standard | ^12.0.0 |
| eslint-plugin-import | ^2.14.0 |
| eslint-plugin-node | ^8.0.1 |
| eslint-plugin-promise | ^4.0.1 |
| eslint-plugin-security | ^1.4.0 |
| eslint-plugin-standard | ^4.0.0 |
| mocha | 5.2.0 |
| nodemon | ^1.18.9 |
| nyc | ^13.2.0 |
| webpack | ^4.19.1 |
| webpack-cli | ^3.2.1 |
The MIT License (MIT)
Copyright (c) 2019 Tamas Szoke
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.