Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 94 lines (56 sloc) 2.502 kb
fa1ae4d Richard D. Worth Added some info to the README
rdworth authored
1 # plugins.jquery.com
2
b85d999 Richard D. Worth Added spec for package.json
rdworth authored
3 The jQuery Plugins site, http://plugins.jquery.com/
fa1ae4d Richard D. Worth Added some info to the README
rdworth authored
4
b815624 adam j. sontag improve readme installation instructions and update plugin process
ajpiano authored
5 ### How it works
fa1ae4d Richard D. Worth Added some info to the README
rdworth authored
6
ec352a2 adam j. sontag More readme improvement
ajpiano authored
7 This site is an index of GitHub repositories that each contain a single jQuery plugin. Each such repository contains a valid `package.json` in the repository root. The specification for this file is in [docs/package.md](/jquery/plugins.jquery.com/blob/master/docs/package.md).
fa1ae4d Richard D. Worth Added some info to the README
rdworth authored
8
b815624 adam j. sontag improve readme installation instructions and update plugin process
ajpiano authored
9 ### How to list a plugin
fa1ae4d Richard D. Worth Added some info to the README
rdworth authored
10
ec352a2 adam j. sontag More readme improvement
ajpiano authored
11 Simply add a [post-receive hook](http://help.github.com/post-receive-hooks/) to your repository with our web hook url, `http://plugins.jquery.com/_update`.
12 **Warning:** This is not yet functional!
fa1ae4d Richard D. Worth Added some info to the README
rdworth authored
13
b815624 adam j. sontag improve readme installation instructions and update plugin process
ajpiano authored
14 ## Development
60a339d Richard D. Worth Added Installing section to README
rdworth authored
15
b815624 adam j. sontag improve readme installation instructions and update plugin process
ajpiano authored
16 ### Requires
13878b4 Richard D. Worth README: Added a 'Requires' section
rdworth authored
17
8391c4b Richard D. Worth README: Added notes about Apache, PHP, and MySql
rdworth authored
18 * jQuery's [web-base-template](https://github.com/jquery/web-base-template)
19 * Web server (such as Apache)
13878b4 Richard D. Worth README: Added a 'Requires' section
rdworth authored
20 * PHP
2b046a5 Richard D. Worth README: corrected case of MySQL
rdworth authored
21 * MySQL
13878b4 Richard D. Worth README: Added a 'Requires' section
rdworth authored
22 * WordPress
ec352a2 adam j. sontag More readme improvement
ajpiano authored
23 * node
13878b4 Richard D. Worth README: Added a 'Requires' section
rdworth authored
24 * git
25
ec352a2 adam j. sontag More readme improvement
ajpiano authored
26 ### Installation
60a339d Richard D. Worth Added Installing section to README
rdworth authored
27
982f4d3 Richard D. Worth README: fixed the order of some steps
rdworth authored
28 ### web-base-template
60a339d Richard D. Worth Added Installing section to README
rdworth authored
29
e9bd1a6 Richard D. Worth README: adjusted indentation, added sample line for /etc/hosts
rdworth authored
30 1. Download or clone web-base-template
60a339d Richard D. Worth Added Installing section to README
rdworth authored
31
e9bd1a6 Richard D. Worth README: adjusted indentation, added sample line for /etc/hosts
rdworth authored
32 * `git clone git://github.com/jquery/web-base-template.git`
60a339d Richard D. Worth Added Installing section to README
rdworth authored
33
b815624 adam j. sontag improve readme installation instructions and update plugin process
ajpiano authored
34 #### HOSTS
15db595 Richard D. Worth README: Added a little more to the Intalling section
rdworth authored
35
970bfbe Richard D. Worth README: changed .local to .dev. Fixes #5
rdworth authored
36 1. Add a `plugins.jquery.com.dev` entry in /etc/hosts
e9bd1a6 Richard D. Worth README: adjusted indentation, added sample line for /etc/hosts
rdworth authored
37
970bfbe Richard D. Worth README: changed .local to .dev. Fixes #5
rdworth authored
38 * `127.0.0.1 plugins.jquery.com.dev`
841335b Richard D. Worth README: Added line about installing WordPress first
rdworth authored
39
b815624 adam j. sontag improve readme installation instructions and update plugin process
ajpiano authored
40 #### WordPress
901c910 Richard D. Worth README: Added steps for pulling themes from web-base-template
rdworth authored
41
b815624 adam j. sontag improve readme installation instructions and update plugin process
ajpiano authored
42 1. Install a web server (such as Apache), PHP, and MySQL.
901c910 Richard D. Worth README: Added steps for pulling themes from web-base-template
rdworth authored
43
8391c4b Richard D. Worth README: Added notes about Apache, PHP, and MySql
rdworth authored
44 2. Follow http://codex.wordpress.org/Installing_WordPress#Famous_5-Minute_Install
45
b815624 adam j. sontag improve readme installation instructions and update plugin process
ajpiano authored
46 3. Redirect your WordPress install to use the web-base-template's theme and config
47 * `rm -rf wordpress/wp-content`
48 * `ln -s web-base-template/wordpress/wp-content wordpress/wp-content`
d598156 Richard D. Worth README: Added lots more detail to install steps, including activating wo...
rdworth authored
49
ec352a2 adam j. sontag More readme improvement
ajpiano authored
50 #### WordPress config
d598156 Richard D. Worth README: Added lots more detail to install steps, including activating wo...
rdworth authored
51
970bfbe Richard D. Worth README: changed .local to .dev. Fixes #5
rdworth authored
52 From http://plugins.jquery.com.dev/wp-admin/
d598156 Richard D. Worth README: Added lots more detail to install steps, including activating wo...
rdworth authored
53
54 1. Activate the plugins-jquery-com theme
55
982f4d3 Richard D. Worth README: fixed the order of some steps
rdworth authored
56 * Select Appearance -> Themes
57 * Under plugins-jquery-com, select 'Activate'
d598156 Richard D. Worth README: Added lots more detail to install steps, including activating wo...
rdworth authored
58
59 2. Activate the jQuery Slugs plugin
60
982f4d3 Richard D. Worth README: fixed the order of some steps
rdworth authored
61 * Select Plugins
62 * Under jQuery Slugs, select 'Activate'
d598156 Richard D. Worth README: Added lots more detail to install steps, including activating wo...
rdworth authored
63
64 3. Set Custom Structure for Permalinks
65
982f4d3 Richard D. Worth README: fixed the order of some steps
rdworth authored
66 * Select Settings -> Permalinks
67 * Select Custom Structure
68 * Enter `/%postname%/`
69 * Click Save Changes
d598156 Richard D. Worth README: Added lots more detail to install steps, including activating wo...
rdworth authored
70
ec352a2 adam j. sontag More readme improvement
ajpiano authored
71 #### Install node >=0.6.4
5ea890f Richard D. Worth README: Added node, npm, npm install steps
rdworth authored
72
e748158 Richard D. Worth README: Removed npm as it's now included in node :)
rdworth authored
73 1. Follow https://github.com/joyent/node/wiki/Installation
5ea890f Richard D. Worth README: Added node, npm, npm install steps
rdworth authored
74
ec352a2 adam j. sontag More readme improvement
ajpiano authored
75 #### plugins.jquery.com setup
d598156 Richard D. Worth README: Added lots more detail to install steps, including activating wo...
rdworth authored
76
77 1. `git clone git@github.com:jquery/plugins.jquery.com.git`
78
79 2. `cd plugins.jquery.com`
80
5ea890f Richard D. Worth README: Added node, npm, npm install steps
rdworth authored
81 3. `npm install`
82
c345f95 Richard D. Worth README: removed the mkdir -p step as it's now handled by main.js, using ...
rdworth authored
83 4. `cp src/config-sample.json src/config.json`
b815624 adam j. sontag improve readme installation instructions and update plugin process
ajpiano authored
84
c345f95 Richard D. Worth README: removed the mkdir -p step as it's now handled by main.js, using ...
rdworth authored
85 5. Edit src/config.json
7457e0a Richard D. Worth README: simplified the steps under editing config.json
rdworth authored
86 * Set `dbName` to your WordPress MySQL database name
87 * Set `dbUser` to your WordPress MySQL database user
88 * Set `dbPassword` to your WordPress MySQL database password
b815624 adam j. sontag improve readme installation instructions and update plugin process
ajpiano authored
89 * Leave `siteId` null (unless you happen to be using a Wordpress multi-site installation locally, in which case supply the site's ID in the multi-site install)
d598156 Richard D. Worth README: Added lots more detail to install steps, including activating wo...
rdworth authored
90
fa66505 Richard D. Worth README: Added new sqlite db setup step (node src/setup.js)
rdworth authored
91 6. `node src/setup.js`
92
93 7. `node src/main.js`
Something went wrong with that request. Please try again.