Giter Club home page Giter Club logo

oktober-foundation's Introduction

Oktober Foundation

Starter development template for building Zurb Foundation 6 themed October CMS sites.

Includes:

Installation

Add the theme to existing project while logged into OctoberCMS account online, or interactively by searching it inside Settings/System/Updates/Themes in backend, or with the following command-line instructions inside project root:

php artisan theme:install zietbukuel.oktober-foundation
php artisan theme:use oktober-foundation

To be able to use Font Awesome we need to make a small change in our .htaccess file.

Look for:

RewriteCond %{REQUEST_FILENAME} !/themes/.*/(assets|resources)/.*

And change it to:

RewriteCond %{REQUEST_FILENAME} !/themes/.*/(assets|resources|node_modules)/.*

As you can see, we just added "node_modules" after "resources". This should allow us to access any asset inside the "node_modules" folder.

One-time Development Environment Setup

Install NodeJS and Node Package Manager globally. Run the following command-line instructions inside theme root:

npm install -g gulp yarn
yarn install

Using and Editing

Custom styles should be in src/scss/style.scss, scripts in src/js/theme.js. Development changes can be automated with command-line instruction inside theme root:

yarn run watch

Build optimized, minified, auto-prefixed assets with command-line instruction inside theme root:

yarn run build -- --production

Yarn commands

  • yarn run build [-- --production] - Compiles the SCSS and Javascript source code.
  • yarn run build-styles [-- --production] - Compiles the SCSS source code.
  • yarn run build-scripts [-- --production] - Compiles the Javascript source code.
  • yarn run clean - Removes everything inside assets/.
  • yarn run watch - Monitors changes inside src/*.

Customizing Foundation

Global Foundation styling parameters should be modified in src/scss/_settings.scss Comment out unwanted styles and scripts for leaner and faster Foundation custom build: src/scss/_foundation6.scss src/js/foundation.js

oktober-foundation's People

Contributors

zietbukuel avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

maxprofs-llcio

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.