Giter Site home page Giter Site logo

digitoimistodude / neckbeard Goto Github PK

View Code? Open in Web Editor NEW
1.0 3.0 0.0 2.34 MB

ABANDONED. For archive purposes only. Neckbeard was a WordPress/WooCommerce starter theme based on storefront, dudestarter and _s.

License: MIT License

PHP 42.38% JavaScript 2.48% CSS 52.71% Shell 2.44%

neckbeard's Introduction

Neckbeard Designed for WooCommerce

Neckbeard is a WordPress starter theme based on storefront, dudestarter and _s, currently used by Digitoimisto Dude Oy, a boutique digital agency from Central Finland, Jyväskylä.

Neckbeard logo

Theme is currently in development.

Table of contents

  1. Please note before using
  2. License
  3. Features
    1. Layout base & grid
    2. Typography
    3. Development
  4. What about clutter?
  5. Requirements
  6. Usage
  7. TODO
  8. Contributing

Please note before using

Neckbeard is a development theme, so it has updates almost daily. By using this starter theme, you agree that the fonts can change, layout can change, everything can change, and they will, without a warning. After all, this is a development theme for Dude's personal preferences and principles and should be considered as yet another agency-boilerplate rather than "a theme for everyone".

If you for some crazy reason happen to use this theme as base, please note the theme won't necessarily be that much fun or won't necessarily look any good. This is just a plain skeleton and nothing else. I recommend using Underscores or Sage if you need something more "complete".

License

Neckbeard is licensed with The MIT License (MIT) which means you can freely use this theme commercially or privately, modify it, or distribute it, but you have to lisence it with the same conditions and you are forbidden to hold Dude liable for anything, or claim that what you do with this is completely, partially or directed made by us.

Features

Layout base & grid

Typography

Development

  • BrowserSync for keeping multiple browsers and devices synchronized while testing, along with injecting updated CSS and JS into your browser while you're developing (included in devpackages)
  • gulp build script that compiles both Less and Sass, checks for JavaScript errors, optimizes images, and concatenates and minifies files (see Dude's devpackages)
  • Bower for front-end package management (see Dude's devpackages)

What about clutter?

Since Neckbeard is based on multiple themes, it tries to combine the best bits without having too much clutter. This is a challenging task (nearly impossible in WooCommerce), but here's something that is left out from Storefront or Underscores to achieve more DRY theme:

  • No customizer (this is dev-theme, not a theme for everyone)
  • No welcome screen (see above)
  • No Jetpack stuff (see above)
  • No bourbon (mostly bloat and useless mixins)
  • No child theme support (this is going to be a starter theme for dev-Dudes)
  • No widgets (see above)
  • No useless functions by default, like social icons
  • No sidebar by default
  • Full width by default

Requirements

  • Mac OS X (development only - not tested on other systems, but feel free to try and report back)
  • Devpackages by Dude - Npm, Gulp and Bower (if you are going to use your own gulpfile, at least see that the paths and bower packages are correct to compile the theme successfully)
  • Dudestack - A toolkit for creating a new professional WordPress project with deployments. Heavily based on Bedrock by Roots.

Usage

Go through Dudestack Instructions to install vagrant development environment and dudestack. Then:

  1. Clone this repository and unpack it to your project folder (or under test directory, for example for us it's ~/Projects/dudetest/content/themes/neckbeard)
  2. Edit STARTERTHEMEPATH to point out to neckbeard in newtheme.sh
  3. Navigate to theme directory with Terminal and run script with sh newtheme.sh (requires Dudestack's createproject command to be run before)
  4. Go to Projects folder and run npm install
  5. Run gulp watch in project-folder
  6. Start with sass/base/config.scss and continue editing from there. The main CSS file will always be sass/base/layout.scss.

TODO

  • Replace bourbon with useful and sensible SASS
  • Add normalize.scss
  • Add responsive typograhpy
  • Clean up clutter
  • Include parts of concise
  • Add screenshot
  • Add default responsive navigation
  • Remove WooCommerce hooks that are not needed
  • Simplify CSS a LOT
  • Disable sidebar by default
  • Make page templates more flexible
  • Use containers instead of full wrapper from header to footer

Contributing

If you have ideas about the theme or spot an issue, please let us know. Before contributing ideas or reporting an issue about "missing" features or things regarding to the nature of that matter, please read Please note section. Thank you very much.

neckbeard's People

Stargazers

 avatar

Watchers

 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.