This scaffolding is robust in terms of security (read below). All important matters (packages) were set up already. From linting to bundling. Also, this is based on MVC (Model-View-Controller) architecture. This scaffolding was meant for backend stuff. For an instance, if you want to create a Node application on the fly. But, you can also use this scaffolding if you want to create simple to advanced websites (frontend stuffs included). The purpose of this repo is to give you all the important tools already set up so you can start building your app ideas right away. Scroll to GET STARTED below if you want to skip all the blah-blah-blah's.
The center gears for this repo are: Node, Express, MongoDB-Mongoose, and es6Renderer. This scaffolding does not use React. But, there will be another scaffolding repo for that. Sole purpose of this scaffolding is for you to create pure Node applications on the fly. But, as stated above, you can also use this in creating simple to advanced websites.
Securing your application is the most vital step in any application development. So implemented in this scaffolding were tested and trusted security modules like: Helmet, CORS, and HPP.
Logger used for this scaffolding are winston and express-winston.
I have included PM2 as its Process Manager. If you're going to deploy, PM2 is a great choice. If you haven't heard about PM2, you can check their documentation or you can omit this one if you like. PM2 is a very powerful tool. It also has a mode for development, using their pm2-dev which provides auto reloading when it detects any file change. And many more! However, I'm only using PM2, for this specific repo as process manager solely - especially its Cluster feature (which is derived from Node).
This scaffolding uses Eslint, eslint-plugin-security (for detecting vulnerable coding style), and eslint-config-airbnb-improved.
This scaffolding uses custom-env as the environment parser. Basically, you can create a .env.testing, .env.development, etc., for your specific environment variables.
NOTE: Don't publicly upload or share your .env files.
I have already included a more reliable and easy-to-use templating engine for express express-es6-template-engine (es6Renderer). This is based on the template string feature of ES6. It's very clean and on-point.
Instead of typing long template engine code, all you have to type inside your HTML is the template string of ES6.
<h1 class="heading">${headingTitle}</h1>
I already configured WebPack 4 for your frontend and backend bundles. I also included Babel. Configuring the backend and frontend for WebPack is a bit daunting and tedious. I already separated your backend bundle (Node stuff) and frontend bundle (DOM stuff), so I already saved your precious time for that.
To auto-reload your browser when you are in development, this scaffolding uses Browser-Refresh. I did not use the webpack-dev-server because I like the simplicity of browser-refresh and its ease of use.
For the database schema, Mongoose was used. For the validation, Joigoose (a JOI-dependent npm) was used. Joigoose has also schemas.
For the test section, I've already included Mocha, Expect and Supertest. But, you can use any test suite you want.
I have also added latest versions of Bootstrap and FontAwesome so that if you decide to create websites or include pages you can do so in no time.
Just clone this repo inside your project directory and then install all its dependencies. This repo uses Yarn, however, if you will use NPM, delete the yarn.lock then 'npm install'.
yarn install
or
npm install
Make sure to uncomment this code:
if (process.send) {
process.send('online');
}
inside the app.js file. This section will allow browser-refresh to work for the auto-reloading of your browser. And, also this one:
<script src=${process.env.BROWSER_REFRESH_URL}></script>
this is placed in the footer.html file which is inside the views/partials/ directory.
If you are ready to deploy or just want to try to build your app, comment out again all the codes mentioned above first then run build script inside the package.json file.
Your main entry point for your backend stuff (Node) is the app.js file. Placed inside the root of your project directory. Your main entry for your frontend stuff is the app-frontend.js file. Placed inside public/js/ directory. The entry points are for development only, because when you deploy, you need to build and minimized all files.
Inside this file are all frontend stuffs. Firstly, this scaffolding uses SASS for the styles (you can use CSS if you want) so that I can easily import all other styles into it. The main scss file is placed inside public/styles/ directory, namely app-main.scss. Inside this scss file, I have imported fontawesome styles and bootstrap styles. Then I imported the app-main.scss into the app-frontend.js file.
Basically, all utility modules, all other modules, styles, and assets like images are imported inside this file, so that when you build (using WebPack) you only have one main entry point for your frontend stuffs.
NOTE: On production, Webpack will automatically extract all css and separate them from the JS files through the use of mini-css-extract-plugin. So, I have already included it in the partials inside views/partials/ directory called header.html, all css files, app.css.
So, after you build your files, your entry point for your backend stuff will be app-back-bundle.js. Still, placed in the root of your project. And, for your frontend stuff, it will be app-front-bundle.js, which will be placed inside public/dist/ directory. Also, this /dist directory will be the source for all your public assets when deployed, like images, svg, etc.
Don't forget to create .env.testing and .env.development files. Inside each file, set your environment variables.
When you are in development stage, you can use this one (you can create your own if you want):
"dev-webp": "concurrently 'webpack --config ./webpack.config.js --mode development --watch true' 'yarn dev-node'"
dev-webp will run webpack on development mode and then after run immediately dev-node
"dev-node": "browser-refresh ./app-back-bundle.js"
dev-node uses browser-refresh for the auto-reloading of your browser. So, whenever you hit save, Webpack will re-bundle and then trigger browser-refresh to reload the browser. By the way, concurrently is a node package that enables you to run scripts after the other.
If you want to try PM2 in your development stage, run this script:
"dev-webp-pm2": "concurrently 'webpack --config ./webpack.config.js --mode development' 'pm2-runtime start ecosystem.config.js --env development'"
Again, it runs Webpack, and then triggers PM2 which is in development mode as well. If all is set and you are ready to deploy run the build script.
"build": "webpack --config ./webpack.config.js --mode production"
Then, on your deployment server you can run the start script that uses PM2 as your Process Manager.
"start": "pm2-runtime start ecosystem.config.js --env production"
If you don't want to use PM2, you can use any other process manager you want, or if you just want to run without any manager you can simply create this:
"start": "node app-back-bundle.js"
You need to run dev-webp script at least once so that Webpack can create the main entry points. You can open localhost:3000 in your browser to test if everything is working.
That's it! You have a robust scaffolding with all important packages already set up for you. But, you can edit all configs, remove or add your own dependency if you want. Please don't forget to star this repo if you find this useful.