Skip to content

Latest commit

 

History

History
85 lines (50 loc) · 4.28 KB

README.md

File metadata and controls

85 lines (50 loc) · 4.28 KB
Raw

Built with Grunt

#Soca

Soca is a responsive administration template built using Yeoman, Grunt, Bower, HTML5, CSS3, JavaScript and Handlebar templating. It was purpose built to be used for Trado, a lightweight, easy to use e-commerce platform designed for sole traders and SME businesses. However, Soca has been released as an open source template for other developers to utilise in their applications.

Official site

Demo site

Release notes

This template is also used with Trado, a new, lightweight, open source e-commerce platform.

##Getting started

For development purposes, this repository requires the use of Grunt and Bower in order to run the application.

Grunt is a JavaScript based task runner, for tasks such as unit testing, compilation, uglifying, livereload, serving web pages and many many more. If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins.

Bower is a package manager tool (much like NuGet or Bundler) which can manage your third party asset library for you. You can find information on using and installing Bower over at their github page.

Furthermore, you will need npm for both of these tools to function. You can find a quick and easy installation guide over at the npm github.

If you would not like to perform any development and want just the basic template click here

##Resolving dependencies

First off, you will need to install the Grunt package dependencies listed in package.json:

npm install

Then you will need to install the Bower asset dependencies, listed in bower.json:

bower install

##Build process

Now we have all our required dependencies, we can start to use the Grunt task runner. To start viewing the application on the Grunt web server, run the following command:

grunt server

If you would like to create a distribution package of the application, ready for use in your application, run the following command:

grunt build

This will run through compiling, uglifying, copying the HTML, JavaScript, CSS and Bower dependencies into a folder called dist in the root of the application.

##Screenshots

###Desktop Tables
Forms
Orders

###Mobile Tables Tables

Versioning

Soca follows Semantic Versioning 2.0 as defined at http://semver.org.

##How to contribute

  • Fork the project
  • Create your feature or bug fix
  • Commit (do not change version or history)
  • Send a pull request against the master branch

##Credits Bootstrap - JS support for tooltips, modals and dropdowns
Font Awesome - Iconography
Icomoon - Iconography
Tim Schlechter - Tag input plugin
Bootstrap-datepicker - Datepicker plugin

##Copyright Copyright (c) 2014 Tom Dallimore (@tom_dallimore)
Licenced under the MIT licence.