Giter VIP home page Giter VIP logo

frontend-boilerplate's Introduction

Front-end boilerplate

Requirements

  • Ruby 2.1+
  • Node 5.0+

Installation

  • npm install -g frot
  • frot [path]

Folder Structure

The demo project homepage contains a detailed project structure explanation. See development section to learn how to build and see the homepage.

Development

  • Run gulp watch
  • Open http://127.0.0.1:8080 in your browser.
  • Livereload is enabled by default.
  • Make sure your code editor / IDE has ESLint support.

Building

  • gulp clean to cleanup the output folder.
  • gulp build to build and optimize / minify assets.
  • See build settings in _config dir.

Deployment

  • gulp surge for Surge deployment.
  • gulp rsync for SSH deployment via RSync.
  • See deployment settings in _config dir.

Components

  • Try to follow the concept of components when developing the front-end.
  • Types of Components
  • Page Blocks are components that are not related to the actual content (eg. header and footer).
  • Regular Components are elementary blocks, used to build the content.
  • Regular components should be flexible enough to be reused on any other page.
  • Each component should have a dedicated partial in _source/_includes/components (Unless it's a ReactJS Component).
  • Each component should have a dedicated stylesheet in _assets/scss/components
  • If the component requires JS or is a ReactJS component, it should have a dedicated JS in _assets/js/components

frontend-boilerplate's People

Contributors

dmitriiivashko avatar jshakes avatar

Watchers

 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.