cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mura...@apache.org
Subject [2/2] cordova-registry-web git commit: added README for npm-search
Date Tue, 07 Jul 2015 21:06:01 GMT
added README for npm-search


Project: http://git-wip-us.apache.org/repos/asf/cordova-registry-web/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-registry-web/commit/2d141c22
Tree: http://git-wip-us.apache.org/repos/asf/cordova-registry-web/tree/2d141c22
Diff: http://git-wip-us.apache.org/repos/asf/cordova-registry-web/diff/2d141c22

Branch: refs/heads/master
Commit: 2d141c227cd2499a6fee545d3e69c73dfaa93277
Parents: dbcb1eb
Author: Murat Sutunc <sutunc@gmail.com>
Authored: Tue Jul 7 14:05:51 2015 -0700
Committer: Murat Sutunc <sutunc@gmail.com>
Committed: Tue Jul 7 14:05:51 2015 -0700

----------------------------------------------------------------------
 npm-search/README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-registry-web/blob/2d141c22/npm-search/README.md
----------------------------------------------------------------------
diff --git a/npm-search/README.md b/npm-search/README.md
new file mode 100644
index 0000000..d500a38
--- /dev/null
+++ b/npm-search/README.md
@@ -0,0 +1,16 @@
+#  Cordova Plugin NPM Search
+This repo contains the assets for [plugins.cordova.io/npm](http://plugins.cordova.io/npm).
Below we go over the steps of getting setup and running locally.
+
+Setup
+=====
+### Clone this repo & install dependencies
+```bash
+git clone https://github.com/apache/cordova-registry-web.git
+```
+In your terminal, navigate to the cordova-registry-web/npm-search directory and `npm install`.
This will install the dependencies required to deploy locally.
+
+We also need to install the `gulp` globally. Type `npm i gulp -g`.
+
+Deploy Locally
+==============
+Once all the dependencies are installed run `gulp dev` and launch a local [HTTP server](https://www.npmjs.com/package/http-server)
in npm-search folder. The web site is designed to run on client side, which means all the
content can be served statically.


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org


Mime
View raw message