Mega Boilerplate is a starter project generator that focuses on simplicity and ease of use, while providing you with flexibility of choices. It was heavily inspired by the Hackathon Starter, but unlike it, you can customize any part of your application stack — from web framework and database to CSS preprocessor and client-side JavaScript framework. Currently, generators are primarily limited to Node.js web apps, but I am planning to expand support for other platforms and languages in the near future.

Getting Started
Express
Meteor
Jekyll
Middleman
JS Library
Database Setup
MongoDB
MySQL
PostgreSQL
SQLite
Project Structure
Obtaining API Keys
Learning Resources
React / Redux
Cheatsheets
ES6
JavaScript Date
Deployment
FAQ
<img src="https://upload.wikimedia.org/wikipedia/commons/thumb/5/57/React.js_logo.svg/50px-React.js_logo.svg.png" height="17"> React
<img src="https://angular.io/resources/images/logos/standard/shield-large.png" height="17"> Angular
Changelog
Contributing
License

Getting Started

Prerequisites

Node.js 6.0
Git
Command Line Tools
<img src="http://deluge-torrent.org/images/apple-logo.gif" height="17"> Mac OS X: Xcode or xcode-select --install
<img src="http://dc942d419843af05523b-ff74ae13537a01be6cfec5927837dcfe.r14.cf1.rackcdn.com/wp-content/uploads/windows-8-50x50.jpg" height="17"> Windows: Visual C++ Build Tools 2015
<img src="https://lh5.googleusercontent.com/-2YS1ceHWyys/AAAAAAAAAAI/AAAAAAAAAAc/0LCb_tsTvmU/s46-c-k/photo.jpg" height="17"> Ubuntu: sudo apt-get install build-essential
<img src="http://i1-news.softpedia-static.com/images/extra/LINUX/small/slw218news1.png" height="17"> Fedora: sudo dnf groupinstall "Development Tools"
<img src="https://en.opensuse.org/images/b/be/Logo-geeko_head.png" height="17"> OpenSUSE: sudo zypper install --type pattern devel_basis

Express

Download and extract the project. Then in your Terminal type the following:

$ cd megaboilerplate-app

# Install NPM dependencies
$ npm install

# Start the app
$ node server.js

# Express server listening on port 3000

Note: If you have selected Gulp or NPM build tool, you may also need to run npm run build command.

Note: If you have selected a database, please make sure it is up and running. For additional information, see Database Setup.

:top: back to top

Jekyll

Prerequisites

Ruby 2.0+
Jekyll Ruby Gem

$ cd megaboilerplate-app

# Start Jekyll app
$ jekyll serve

# Server address: http://127.0.0.1:4000/
# Server running... press ctrl-c to stop.

:top: back to top

Middleman

Prerequisites

Ruby 2.0+
Middleman Ruby Gem

$ cd megaboilerplate-app

# Install Ruby dependencies
$ bundle install

# Start Middleman app
$ bundle exec middleman

# The Middleman is loading
# View your site at "http://localhost:4567"

:top: back to top

JS Library

This JavaScript library boilerplate was inspired and based on Dan Abramov's library-boilerplate project. The main idea here is you write your code in ES6, which then gets transpiled into CommonJS and UMD builds. Consider lodash as an example - a very popular JavaScript library that supports ES6 import, CommonJS require() and can be used inside a browser via <script> tag.

$ cd megaboilerplate-app

# Install NPM dependencies
$ npm install

# ES5 / CommonJS build
$ npm run build

# UMD build
$ npm run build:umd

# Run tests
$ npm test

:top: back to top

:top: back to top

MongoDB

<img src="http://deluge-torrent.org/images/apple-logo.gif" height="17"> Mac OS X

Install Homebrew package manager. Then follow the steps below to install and setup MongoDB.

# Update Homebrew's package database
$ brew update

# Install MongoDB
$ brew install mongodb

# Create the data directory
$ sudo mkdir -p /data/db

# Set permissions for the data directory
$ sudo chown -R `whoami` /data/db

# Run MongoDB Server
$ mongod

<img src="http://dc942d419843af05523b-ff74ae13537a01be6cfec5927837dcfe.r14.cf1.rackcdn.com/wp-content/uploads/windows-8-50x50.jpg" height="17"> Windows

Download and install the current stable release.
Create the data directory: C:\data\db.
Run MongoDB Server by opening mongod.exe in C:\Program Files\MongoDB\Server\3.2\bin.

<img src="https://lh5.googleusercontent.com/-2YS1ceHWyys/AAAAAAAAAAI/AAAAAAAAAAc/0LCb_tsTvmU/s46-c-k/photo.jpg" height="17"> Ubuntu

# Import the public key used by the package management system
$ sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv EA312927

# Create a source list file for MongoDB
$ echo "deb http://repo.mongodb.org/apt/ubuntu trusty/mongodb-org/3.2 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-3.2.list

# Update the repository
$ sudo apt-get update

# Install the latest stable version of MongoDB
$ sudo apt-get install -y mongodb-org

# Start MongoDB service
$ sudo service mongod start

:top: back to top

MySQL

Use database settings below in the .env file.

| Key | Value | | ------------- |:-----------------------------------------------------------------:| | DB_HOST | localhost | | DB_USER | root | | DB_PASSWORD | (use root password configured during installation or leave blank) | | DB_NAME | mysql |

<img src="http://deluge-torrent.org/images/apple-logo.gif" height="17"> Mac OS X

Install Homebrew package manager. Then follow the steps below to install and start MySQL.

# Update Homebrew's package database
$ brew update

# Install MySQL
$ brew install mysql

# Start MySQL Server
$ mysql.server start

<img src="http://dc942d419843af05523b-ff74ae13537a01be6cfec5927837dcfe.r14.cf1.rackcdn.com/wp-content/uploads/windows-8-50x50.jpg" height="17"> Windows

Download MySQL Installer for Windows.
Start the installer and follow instructions until the installation is complete.

When prompted, choose Server only or Developer Default setup type.

Note: Alternatively, you may use XAMPP, which already comes bundled with MySQL and phpMyAdmin.

<img src="https://lh5.googleusercontent.com/-2YS1ceHWyys/AAAAAAAAAAI/AAAAAAAAAAc/0LCb_tsTvmU/s46-c-k/photo.jpg" height="17"> Ubuntu

# Update the repository
$ sudo apt-get update
$ sudo apt-get upgrade

# Install MySQL
$ sudo apt-get install mysql-server

:top: back to top

PostgreSQL

Use database settings below in the .env file.

| Key | Value | | ------------- |:-----------------------------------------------------------------:| | DB_HOST | localhost | | DB_USER | postgres | | DB_PASSWORD | (use root password configured during installation) | | DB_NAME | postgres |

<img src="http://deluge-torrent.org/images/apple-logo.gif" height="17"> Mac OS X

Install Homebrew package manager. Then follow the steps below to install and start PostgreSQL.

# Update Homebrew's package database
$ brew update

# Install PostgreSQL
$ brew install postgres

# Start PostgreSQL Server
$ postgres -D /usr/local/var/postgres

<img src="http://dc942d419843af05523b-ff74a

Megaboilerplate

Install / Use

README

Table of Contents

Getting Started

Prerequisites

Express

Jekyll

Prerequisites

Middleman

Prerequisites

JS Library

Database Setup

MongoDB

MySQL

PostgreSQL