Git Product home page Git Product logo

crozier-demo's Introduction

FED Starter Kit

General info

This is a Bootstrap 5 Boilerplate with Gulp 4+. Sass, browser-sync. “Basic” is the ultimate Bootstrap 5 starter boilerplate with Gulp 4 and webpack for automation and rapid development.

Feature

  • Modular Architecture (Scss, html, javascript) in dev side.
  • BEM Methodology
  • Gsap for animations.

Prerequisite

Project is created with:

  • Node > 14 (tested in 14.18.2)

Technologies

Project is created with:

  • Bootstrap 5
  • Gulp 4
  • Sass
  • Sourcemaps
  • Webpack
  • Concatenation
  • CSS minification
  • HTML minitification
  • Uglify
  • Image optimization
  • Gulpfile Include
  • BroswserSync
  • Live reload
  • Jquery if required.

Installation

yarn install
yarn dev
yarn build

You should see a live browser at http://localhost:3000/.

Development

Override Bootstrap’s variables and create your custom styles

dev/scss/variables.scss

Add custom scripts Modular structure

src/js/index.js

Production

yarn build

Folder Architecture

  • dev
    • fonts (Used for custom font)
    • images (Used for static image and assets)
    • includes (Used to include modular html file throughout the pages)
      • Include has modules folder where all developed modules section are inserted.
      • Global Modules html like header, footer.html are kept outside
      • Each Modules and its variation should have separate modules scss and javascript file if needed within the modules.
    • scripts (Used to define global and modular javascript within)
      • Global functions and utility should be present within app.js which will be called throughout the files.
      • Separate modules javascript should have same name as modules developed and should be included with the modules inside Includes folder with same name.
    • scss (Used to define global app.scss and design.scss as entry point. app.scss is used globally and design.scss is used to define modular scss file associated within the files)
      • app.css(complied version of app.scss) should be used globally everywhere within the site.
      • app.scss contains all bootstrap5 needed global things like variables(colors, size ...) , buttons , form input which are being used throughout the site.
      • design.scss will contain all the modular css associated with the modules and included on our architecture but should be implemented individually within the modules used while developing on sitecore.
  • gulpfile.js / gulpSettings (Used to automate the process with gulp 4 and webpack )

Example Usage

  • For Example we have slider module which have slider.html, slider.js and slider.scss or slider.min.css which will be inside dist folder(Compiled version of dev folder including all complied code).
  • slider.html is inside dev/includes/section.slider.html
  • slider.js iis inside script/modules/slider.js
  • slider.scss is inside scss/styles/slider.scss
  • With this 3 files slider modules is made which can be used as per need on the pages.

crozier-demo's People

Contributors

synsuman avatar puriar5 avatar saugatshrestha avatar sanjaymhj avatar

Watchers

 avatar  avatar  avatar Ayaz Uddin avatar Aayush avatar  avatar  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.