goatcurry v1.0.114

Goat Curry

A open source plug and play content editor, delivers clean and easy JSON style output that you can store anywhere.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

node js 
npm

Installing

A step by step series of examples that tell you how to get a development env running

Firstly you will need node and npm installed on your local environment. Then clone or fork the repo. Then run these commands

npm install
npm run build

This will produce a bundled build of the editor. To run the live development scenario us the command below

npm run start

Running the tests

TBD - Looking for first workin example

Coding style

Code style I have chosen to use Airbnb's Javascript style guide

Built With

• Sizzle - A sizzlin' hot selector engine.
• sanitize-html - provides a simple HTML sanitizer with a clear API

Contributing

Actively Looking for contributors :)

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository. Note: Yet to fully realise version 1.0.0

Authors

• Tom Kiernan - Initial work - Tom Kiernan

License

This project is licensed under the GNU Lesser General Public License v3.0 - see the LICENSE.md file for details