Giter Site home page Giter Site logo

symphtml5's Introduction

Symphtml5

Overview

Symphtml5 is a simple HTML5 starter workspace for Symphony CMS. Its purpose is to take care of repetitive tasks when getting a new project up and rolling.

Usage

Symphtml5 relies on a couple of dependencies. It doesn't have to, but they make the process so much less painful that I recommend it.

First, all the styles are compiled from SASS. SASS requires both Ruby, and the SASS gem to be installed on your machine. Secondly, it uses Grunt.js, so with that, you'll need to have both node.js and grunt-cli installed on your system. Grunt is used to do the following:

  1. SASS Compiling and JS Linting on the fly
  2. Watching / LiveReload
  3. Moving any extension submodules to the correct directory

Once you have the dependencies in place, you can get up and running.

Get Symphony

Clone down the Symphony CMS repository, then change into your directory:

git clone git://github.com/symphonycms/symphony-2.git your_directory

cd your_directory

Clone down the submodules:

git submodule update --init --recursive

Don't clone the default Symphony ensemble/workspace directory.

Get Symphtml5

Clone the Symphtml5 repository into the workspace folder, then change into it:

git clone git://github.com/Implemint/Symphtml5.git workspace

cd workspace

Clone down any submodules once again:

git submodule update --init --recursive

Run npm install to get all the Grunt files ready.

Now run grunt copy. This will copy the extensions/ directory into your Symphony core.

Now simply point your browser to your directory and walk through the installation process like normal.

Developing

Once you have Symphony installed, you can use Grunt while you develop to watch for changes and run tasks on the fly. Simply run grunt from the inside the directory with Terminal.

By default, I put all of my assets in a public/ folder, ie: public/styles public/scripts public/fonts, etc.

Grunt is watching and compiling SASS files that live in public/styles/sass. The css then is compiled to public/styles. You can change this, but make sure you update both the utilities/base.xsl and Gruntfile.js to point to the correct directories.

####Changelog

#####1.0.0 - July 31st, 2013

  • Massive simplification. No longer an "Ensemble", now just a workspace folder making very few assumptions in the code.
  • Created grunt file for mundane tasks

#####0.5 - December 31st, 2011

  • Updated to Symphony 2.2.5
  • Removed scripts.xsl utility, replaced with xsl:template modes
  • Updated jquery to 1.7.1

#####0.4 - August 23rd, 2011

  • Updated to Symphony 2.2.3
  • Removed reset.css for normalize.css
  • Cleaned up some left unnecessary leftovers from previous versions
  • Added scripts.xsl back in (not sure how that went away)
  • Added in a responsive grid system

#####0.3 - August 3rd, 2011

  • Updated to Symphony 2.2.2
  • Updated jquery to 1.6.2
  • Removed formalize (It's nice, I just never ended up using it)

#####0.2.1 - May 23rd, 2011

  • Changed the readme to reflect this specific ensemble
  • Updated jquery to 1.6.1

#####0.2 - April 28th, 2011

  • Updated to Symphony 2.2.1
  • Bug fix for incorrect workspace variable in scripts
  • Moved scripts to a separate utility
  • Changed jquery to 1.6

#####0.1 - March 3rd, 2011

  • Initial commit

symphtml5's People

Contributors

loremipson avatar

Stargazers

 avatar Andrew Minton avatar kracher avatar wastemobile avatar David Oliver avatar

Watchers

wastemobile avatar Marcin Antczak avatar  avatar James Cloos avatar

symphtml5's Issues

-bash: grunt: command not found (noob question)

This may not be the right place to ask this, but here it goes. After cloning the repositories from git and running npm install successfully, I get this when running grunt copy:
-bash: grunt: command not found

I tried to remove everything and do it again to be sure, but same result. I guess there is something wrong / missing with the path's, but I'm not that familiar with using the terminal / bash.

Any ideas?

Edit:
I ran npm run-script grunt copy without any errors. Hope it was doing what it was supposed to do :) I'm also new to node.js, so bear with me.

Conflict between headjs and google map api

Google maps API has headjs like functionality built in which is causing conflicts.. XSLT utilities like Get Google Map, or just simply adding a google map to a page are not working at the moment..

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.