Giter Club home page Giter Club logo

frontend-boilerplate's Introduction

#Front-end boilerplate

##Contents:

  1. Explanation
  2. Used tools
  3. Deep understand

Explanation:

This is a boilerplate made for easy and fast project setup. It supports React, Webpack, Gulp and a lot more tools.

Getting Started:

npm run start #will run npm install and first bundle of files
npm run server #will start server

Development steps:

npm run dev #will initialize the server, webapp and asset bundle

Testing steps:

Single Run:

npm run test #will test all specs

Development Run(BDD):

npm run dev
gulp bdd #will run every test on save

Deployment steps:

npm run deploy #this will take a while

Used tools:

  • React
    • Flux
  • Flow
  • Webpack
  • Gulp
  • Fetch
  • Babel
  • Mocha
  • Chai
  • Bulma.io
  • SCSS
    • ITCSS

Deep understand

NPM Scripts:

  • npm run start - will start de project, intall dependencies and build application
  • npm run server - will start the default node server
  • npm run test - will run the test suite once
  • npm run dev - will start the development server and assets compilation watch
  • npm run build - will build both assets and application
  • npm run build:js - will build js minified
  • npm run build:scss - will build scss minified
  • npm run bundle:js - will bundle js files into one
  • npm run bundle:scss - will bundle scss files into one
  • npm run dev-server - will start the development server
  • npm run watch:js - will start the webpack watch -> build cycle
  • npm run deploy:js - will build js and move to de deployment dir
  • npm run deploy - will run the deployment steps heavy step
  • npm run increase:major - will increase major number of package.json
  • npm run increase:minor - will increase minor number of package.json
  • npm run increase:release - will increase release number of package.json
  • npm run publish - will publish the deployment folder into surge.sh

Gulp Scripts:

  • gulp bundle:js - will spawn npm run bundle:js
  • gulp bundle:scss - will compile scss files into one
  • gulp watch:scss - will start watch -> build cycle to scss files
  • gulp bdd - will start watch -> test cycle for every application change
  • gulp run:build - will spawn build:js and build:scss
  • gulp run:test - will run test suite once
  • Deployment steps should be run by NPM not gulp

Made by: @joaomarcuslf

frontend-boilerplate's People

Contributors

joaomarcuslf avatar

Watchers

 avatar

frontend-boilerplate's Issues

Suggestions

Couple of suggestions:

  • Add dependencies on the main command line
    • Add installation commands for each one (based on a repo Unix/Powershell)
  • Add output size of complete boilerplate built for debug/test/release purposes;
  • Add notes on heavy processes (watch:multi)

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.