Giter VIP home page Giter VIP logo

just-do-it's Introduction

Just Do It

Follow me

๐Ÿ’ป Website ๐ŸฆTwitter

๐Ÿ”” Overview

A Gruntfile.js and package.json template ready to copy into your WordPress plugin projects. Just configure the package.json file to your requirements and run the Grunt commands below after installing the dependencies.

Developer Dependancies

These are the dependencies in use for testing, building, updating the language POT file and building a deployable plugin zipped up.

๐Ÿ’ฝ Installation

  1. Install Node.js & NPM and Grunt by following the standard installation instructions or using Homebrew.

If you've installed NPM correctly, this should display the version:

$ npm --version

If you've install Grunt correctly, this should display the version:

$ grunt --version

  1. Change to the plugin root directory.

Install the Grunt dependencies by running the npm installer with the following command:

$ npm install --dev or $ npm install --only=dev

  1. Run tests.

$ grunt test

Add --force at the end to tell grunt to continue next tasks even if one fails.

$ grunt test --force

๐Ÿฝ Grunt Commands

Build the plugin.

String Replacements (i.e. Plugin Version), Compresses the JavaScript, Checks for Text Domain issues and Updates the POT file.

$ grunt build

Similar to the build command except it does not check for text domains issues.

$ grunt dev

Checks for any text domain issues and updates the POT file.

$ grunt update-pot

Copies the plugin to create deployable plugin, then compresses the folder and then deletes the folder once compressed.

The zip file will be labelled as %= pkg.name %-v%= pkg.version %.zip

$ grunt zip

Contribute

If you or your company use Just Do It or appreciate the work Iโ€™m doing in open source, please consider supporting me directly so I can continue maintaining it.

You'll be helping to ensure I can spend the time not just fixing bugs, but keeping the project afloat. Any contribution you make is a big help and is greatly appreciated.

Please also consider starring โœจ and sharing ๐Ÿ‘ the project repo! This helps the project getting known and grow with the community. ๐Ÿ™

I accept one-time donations and monthly via BuyMeACoffee.com

  • My PayPal
  • BuyMeACoffee.com
  • Bitcoin (BTC): 3L4cU7VJsXBFckstfJdP2moaNhTHzVDkKQ
  • Ethereum (ETH): 0xc6a3C18cf11f5307bFa11F8BCBD51F355b6431cB
  • Litecoin (LTC): MNNy3xBK8sM8t1YUA2iAwdi9wRvZp9yRoi

Thank you for your support! ๐Ÿ™Œ

License

Just Do It is released under GNU General Public License v3.0.


just-do-it's People

Contributors

seb86 avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

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.