Giter VIP home page Giter VIP logo

es6-boilerplate-webapp's Introduction

This Repo is monitored by Snyk

Known Vulnerabilities

ES6 Boilerplate Web Application

This repo is intended to minimise the time spent on creating a NodeJS Web App from scratch.

All you need to do is create the .env file and populate it with your own secrets and your ready to go.

Ive really benefitted from the open-source community so here's a contribution to hopefully help others.

Built With

  • NodeJS - Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine.
  • NPM - Relied upon by more than 11 million developers worldwide!
  • MVC - The Model-View-Controller (MVC) is an architectural pattern.
  • ExpressJS - Fast, unopinionated, minimalist web framework for node.
  • Mongoose - Mongoose is a MongoDB object modeling tool.
  • HelmetJS - Helmet helps you secure your Express apps.
  • Body-Parser - Parse incoming request bodies vailable under the req.body property.
  • Cookie-Session - A user session can be stored on the server or on the client.
  • Compression - Compression decreases amount of data that’s served to users.
  • Dotenv - Loads environment variables from .env for nodejs projects.
  • Csurf - Node.js CSRF protection middleware.
  • Pug - Pug is a robust, elegant, feature rich template engine for Node.js.
  • Bootstrap4 - The world’s most popular framework for building responsive, mobile-first websites.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Installed on your machine:

npm v6^

node v10^

Installing

  • Create New .env file in root DIR & copy and pastes the values listed below:

    Values
    LOCAL_DIRNAME=
    PORT=
    NODE_ENV='development'
    DB_STAGING=AddYourDbConnectString
    DB_PRODUCTION=AddYourDbConnectString
    DB_DEVELOPMENT=AddYourDbConnectString
    CK_1=ADD YOUR OWN CK 12 Keys. see ***
    CK_2=
    CK_3=
    CK_4=
    CK_5=
    CK_6=
    CK_7=
    CK_8=
    CK_9=
    CK_10=
    CK_11=
    CK_12=

*** Random string e.g i6qphjQY>xmpaqhhjamgo|ike@x

  • Then Run Command:

    npm i

Running

Dev Env:

    nodemon --exec babel-node app.js

Prod Env:

    npm start

Author

  • Jerome Hurley

License

This project is licensed under the MIT License - see the LICENSE.md file for details

es6-boilerplate-webapp's People

Contributors

dependabot[bot] avatar jpldevpub avatar snyk-bot avatar vonswirl avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Forkers

gtechsltn

es6-boilerplate-webapp's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.