Skip to content

Latest commit

 

History

History
48 lines (35 loc) · 2.07 KB

README.md

File metadata and controls

48 lines (35 loc) · 2.07 KB

ContentTools

Build Status Join the chat at https://gitter.im/GetmeUK/ContentTools

A JS library for building WYSIWYG editors for HTML content.

Demo

Building

To build the library you'll need to use Grunt. First install the required node modules (grunt-cli must be installed):

git clone https://github.com/GetmeUK/ContentTools.git
cd ContentTools
npm install

Install Sass (if not already installed):

gem install sass

Then run grunt build to build the project.

Testing

To test the library you'll need to use Jasmine. First install Jasmine:

git clone https://github.com/pivotal/jasmine.git
mkdir ContentTools/jasmine
mv jasmine/dist/jasmine-standalone-2.0.3.zip ContentTools/jasmine
cd ContentTools/jasmine
unzip jasmine-standalone-2.0.3.zip

Then open ContentTools/SpecRunner.html in a browser to run the tests.

Alternatively you can use grunt jasmine to run the tests from the command line.

Documentation

Full documentation is available at http://getcontenttools.com/api/content-tools

Browser support

The current aim is for all the libraries to support IE9+, Chrome and Firefox. Test suites are complete for all the libraries except ContentTools and I'm using Jasmine to check that the tests pass in those browsers.

There will be some visual differences for ContentTools in IE9 as I use CSS animations for some of the UI feedback.

Helpful organizations

ContentTools is developed using a number of tools & services provided for free by nice folks at organizations committed to supporting open-source projects including BrowserStack, GitHub and Travis CI.