Skip to content

Latest commit

 

History

History
126 lines (77 loc) · 5.17 KB

readme.md

File metadata and controls

126 lines (77 loc) · 5.17 KB

Jetpack

License Code Climate

Jetpack is a WordPress plugin that supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.

For more information, check out jetpack.com.

Get Started

To install the Jetpack plugin on your site, follow the instructions on this page.

Get Help

Do you need help installing Jetpack, or do you have questions about one of the Jetpack modules? You can search through our documentation here. If you don't find the answers you're looking for, you can send us an email or start a new thread in the WordPress.org support forums.

Installation from git repo

The master-stable branch of this repo contains an stable version with every JS and CSS file pre-built.

CD into your Plugins directory

$ git clone [email protected]:Automattic/jetpack.git
$ cd jetpack
$ git checkout master-stable

Contribute

Developers of all levels can help — whether you can barely recognize a filter (or don’t know what that means) or you’ve already authored your own plugins, there are ways for you to pitch in. Blast off:

Development workflow

The javascript and CSS components of this plugin's admin interface need to be built in order to get the runtime bundle (_inc/build/admin.js)

Recommended Dependencies

Recommended environment:

  • Node 6.x
  • npm 3.8.x

If you're having trouble installing 6.x, nvm is a nice tool for node version management :)

Start Development

  1. Make sure you have git, node, and npm installed and a working WordPress installation.

  2. Clone this repository locally inside your /wp-content/plugins directory.

    git clone https://github.com/Automattic/jetpack.git
    
  3. Make sure the Jetpack plugin is active and run

    npm run build
    

    This will install npm dependencies and then build the files.

  4. Open /wp-admin/admin.php?page=jetpack in your browser.

Production build

The production build will generate minified files without duplicated code (resulting from dependencies) and also will generate the matching sourcemap files and language files.

npm run build-production

Development build

The development build will create a build without minifying or deduping code.

npm run build

Development build with changes monitoring (watch)

Running npm run watch instead of npm run build will build all the code and continuously watch the front-end JS and CSS/Sass for changes and rebuild accordingly.

Before running npm run watch you may need to npm install the npm dependencies first if you didn't do it already.

Clone this repository inside your Plugins directory.

$ git clone [email protected]:Automattic/jetpack.git
$ cd jetpack
$ npm install
$ npm run watch

Unit-testing the JS Admin Page

You can run Mocha based tests for the Admin Page source code with npm run test-client

Standing on your jetpack directory, run

$ npm install
$ npm run test-client

Monitor our activity on this repository

Throughput Graph

Team

The Jetpack Pit Crew is comprised of @dereksmart, @samhotchkiss, @zinigor, @eliorivero, and @rcoll.

Contributions have been and continue to be made by dozens of other Automatticians, like:

@georgestephanis, @jeffgolenski, @jessefriedman, @richardmuscat, @justinkropp, @aliso, @allendav, @alternatekev, @apeatling, @azaozz, @bazza, @beaulebens, @cfinke, @daniloercoli, @enejb, @eoigal, @ethitter, @gibrown, @hugobaeta, @jasmussen, @jblz, @jkudish, @johnjamesjacoby, @justinshreve, @koke, @kovshenin, @lancewillett, @lezama, @martinremy, @MichaelArestad, @mtias, @mcsf, @mdawaffe, @nickmomrik, @obenland, @oskosk, @pento, @rase-, @roccotripaldi, @skeltoac, @stephdau, @tmoorewp, @Viper007Bond, @xyu and @yoavf.

Our awesome happiness engineers are @jeherve, @richardmtl, @csonnek, @rcowles, @kraftbj, @chaselivingston, @jenhooks, @aheckler, @ntpixels, @macmanx2, @lschuyler, @seejacobscott, @davoraltman, @lamdayap, @rachelsquirrel, @scarstocea, @stefmattana, @jamilabreu, @cena, @v18, @bikedorkjon, @drpottex, @gregwp, @annezazuu, and @danjjohnson.

Interested in working on awesome open-source code all day? Join us!