Git Product home page Git Product logo

castlecss-boilerplate's Introduction

CastleCSS Boilerplate

CastleCSS is a modular, updatable and easy to use HTML and SCSS framework. Use this Boilerplate to get started with your project right away!

CastleCSS logo @CastleCss.com

What's included?

How to install

  • Download or clone this package
  • Install the project: npm install

Build and run automatically

  • Start the project with: npm run start

This will automatically start a browserSync server.
The project will watch for changes in your scss and html files in your root and scss folder and automatically reload when you change something

Build and run manually

  • Build the project: npm run create_all
  • Only build CSS: npm run create_css

Basic structure

The basis structure for your website should look similar like this:

| Project directory/
|
|-- node_modules/
| | -- castlecss-core/
| | --castlecss-buttons/
| | --castlecss-notifications/
| |
|-- scss/
| |-- main.scss
| |-- variables.scss
| |
|-- img/
|-- dist/
| |-- styles.min.css
| |-- styles.min.map
| |
|-- index.html
|-- Gruntfile.js
|-- package.json

main.scss

Your main.scss should have the following set-up:

/* 	CastleCSS Core variables */
@import "node_modules/castlecss-core/sass/variables";

/* 	Your variables */
@import "variables";

/* 	Remaining Core files and other CastleCSS modules */
@import "node_modules/castlecss-core/sass/main";
@import "node_modules/castlecss-buttons/sass/main";
@import "node_modules/castlecss-notifications/sass/main";

/* Include your own files below this line
   -------------------------------------- */



/* --------------------------------------
   Include your own files above this line */

@import "node_modules/castlecss-core/sass/base/utility";
@import "node_modules/castlecss-core/sass/base/utility_spacers";

Documentation and examples

Check out http://www.castlecss.com for an extended documentation and more examples!

castlecss-boilerplate's People

Contributors

amberjasmijn avatar dariusrosendahl avatar pauldenieuwezaak avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

castlecss-boilerplate's Issues

Difficult naming methodology

Hi there,

an other css framework is a step again in the future. I believe that is good to have as many options as we can and I thank you for your contribution here.

Though, I will not use this framework for now and my biggest issue is the naming of the classes.
It is probably a personal (or not) thing but I find very bad the naming of the classes. I would prefer something that tells me that it's framework's class first and secondary better explanatory about its functionality.

For example m is the class for default margin. One letter class is the definition of bad naming. This is happening also in most of naming on the classes and at least for my team this is not something useful.

I wish you best of luck.

Gulp support

To cater to a broader audience it would be nice to support gulp in the future.

Implementing it would be easy and it could run next to Grunt.

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.