https://github.com/conneraiken/mern-boilerplate

React + Express + Webpack + Mongo = MERN Stack Boilerplate
https://github.com/conneraiken/mern-boilerplate

boilerplate es6 es6-javascript eslint express express-js expressjs mern mern-boilerplate mern-stack react sass-loader webpack

Last synced: about 1 month ago
JSON representation

React + Express + Webpack + Mongo = MERN Stack Boilerplate

• Host: GitHub
• URL: https://github.com/conneraiken/mern-boilerplate
• Owner: ConnerAiken
• License: mit
• Created: 2018-03-31T04:04:02.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-08-23T19:27:43.000Z (over 1 year ago)
• Last Synced: 2024-11-12T16:03:15.192Z (about 1 month ago)
• Topics: boilerplate, es6, es6-javascript, eslint, express, express-js, expressjs, mern, mern-boilerplate, mern-stack, react, sass-loader, webpack
• Language: JavaScript
• Homepage:
• Size: 1.45 MB
• Stars: 40
• Watchers: 3
• Forks: 8
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# MERN Boilerplate - MongoDB, Express, React, NodeJS

## Status

 [![Build Status](https://travis-ci.org/ConnerAiken/mern-boilerplate.svg?branch=master)](https://travis-ci.org/ConnerAiken/mern-boilerplate)

## Dependencies 

- Python 2 (node-gyp)

- NodeJS (9+ preferred)

- Docker (CE is fine, 17+ preferred)

## Features

*Full stack javascript, so get the latest version of Node!*

- [X] Webpack 4

- [X] React 

- [X] Express

- [X] Sass

- [X] ES6 - Stage-0+

- [ ] Linting

- [ ] UI/Unit Tests

## Installation

1) `git clone  && cd `

2) `npm install`

3) Running the application

   - Development Mode (Client only): `npm run dev` then open `http://localhost:8080` in a browser

   - Production Bundle (Client only): `npm run build` then import the client code somewhere

   - Standalone (Client+Server): `npm start` then open `http://localhost:8080` in a browser

   - Dockerized /w MongoDB: `npm run start:docker` - more to come

## Usage

A good place to start would be the .env files. Copy `.env.default` in the root of the project and name the copy `.env`. Replace the values as you see fit. Next, open `docker-compose.yml` and replace the text 'boilerplate' with the app name you put in the env file. After that, you should be in a good place to start customizing it.

## Assumptions

- You have all dependencies installed and are using NPM or Yarn

- This boilerplate was developed using linux mint (Ubuntu 14 - Xenial), it should be cross platform so please report any issues using the github issue tracker.

- If you run the 'npm run updateDeps' script, you will need to have npm-check-updates globally installed: `npm install -g npm-check-updates`   

- Your user account is part of the docker group for sudo access

## Transpiling/Bundling/Polyfills

We currently use babel configured with preset-env, preset-react and preset-stage-0. Eventually the polyfill.io cdn will be primarily used.

## Resources/Sources

### Lifecycle scripts

- npm start

- npm run dev

- npm run upgradeDeps

- npm run build

- npm test

### Credits

[Valentino G](https://www.valentinog.com/blog/webpack-4-tutorial/)

## TODO

- [ ] Add polyfill.io to html-webpack-plugin

- [ ] Add mocha/webdriverio tests

- [ ] Using webpack-merge or lodash for webpack.*env*.js files

- [ ] Add documentation library

- [ ] Setup ESLint

- [ ] Add colors to logging

- [ ] Fix load order (DOM flash)

- [ ] Add deployment command for dockerized mongodb

- [ ] Integrate docker commands into travis?

- [ ] Add webpack bundle analyzer npm script (pipe --stats > stats.json directly into analyzer)

- [ ] Setup provisioning of mongodb

- [ ] Add database connectors