Giter Club home page Giter Club logo

generator-fullstack's Introduction

Full-stack generator NPM version NPM Downloads Dependency Status License

Installation

First, install Yeoman and the Full-stack generator using npm:

npm i -g yo generator-fullstack

Then generate your new project:

yo fullstack

Information

This is a generator providing the following options...

JavaScript:

  • Vanilla
  • Vue.js (incl/ single file components, vue-router & vue-i18n)
  • React

CSS:

  • Stylus
  • Sass
  • SCSS

...based upon a foundation of the following:

  • Node.js / Express on the backend
  • Pug templating language
  • npm for package management (Yarn will be used if available)
  • dotenv for enviromment variables
  • Babel transpilation for ES2015 & ES2016 down to ES5 and optionally a few useful polyfills (detailed below)

Legacy Browsers

During setup you will be asked for your targeted browser support. "Modern" is defined as the latest versions of Chrome, Firefox, Edge, and Safari. "Legacy" is summarily defined as IE9+.

The following JS polyfills are included in legacy builds:

  • Promise - no native support in IE
  • Element.classList - no native support below IE10, and only partial support in IE10 & IE11
  • Window.matchMedia() - no native support below IE10
  • String.prototype.includes() - no native support in IE, Opera
  • Array.from() - no native support in IE, Opera

If you select the modern browsers configuration these polyfills will not be included.

For now, Babel transpilation down to ES5 will be included in all builds.

Directory Setup

Following generation you will end up with something like this, dependent upon the options you selected:

.
├── app/
│   └── routes.js
│   └── server.js
│   └── src/
│       └── modules/
│           └── [etc].js
│       └── styles/
│           └── [etc].styl
│       └── client.js
│   └── static/
│       └── humans.txt
│       └── img/
│   └── views/
│       └── [etc].pug
├── build/
│   └── webpack.base.config.js
│   └── webpack.development.config.js
│   └── webpack.production.js
├── .babelrc
├── .editorconfig
├── .env.example
├── .eslintrc
├── .gitignore
├── CHANGELOG.md
├── README.md
├── package.json

Help

Once generation is complete you should check the generated README for a quick setup guide. The project should immediately run and function as if you'd painstakingly scaffolded it out yourself. If for any reason that doesn't happen, please file an issue detailing the options you selected, the error that was thrown (if any), and any further pertinent information.

generator-fullstack's People

Watchers

 avatar  avatar

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.