From 834be609267c7d190e683abf72d01056de52482e Mon Sep 17 00:00:00 2001 From: Daniel Morgenstern Date: Mon, 19 Nov 2018 00:01:47 +0100 Subject: [PATCH 1/2] fix readme formating --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index abecf96..ad5425b 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # npmFrog -> > A nice npmjs.org-like web interface for jFrog Artifactory +> A nice npmjs.org-like web interface for jFrog Artifactory To share frontend code inside your company between different projects and developers, you can use a private npm registry like Verdaccio or jFrog's Artifactory (which is often used for Maven dependency management in the Java Environment). The latter lacks of a good UI for web devlopers, so npmFrog will present you the self-hosted packages of your company in a more familiar and discoverable way. -It's free and open source. +It's free and open source. :) ![Screenshot](art/screenshot-list.png) From eb264398b5a1c44d2a32a108af85a0e63694b1ad Mon Sep 17 00:00:00 2001 From: Daniel Morgenstern Date: Mon, 19 Nov 2018 00:11:22 +0100 Subject: [PATCH 2/2] README: add prerequisites and more --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ad5425b..be7c383 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # npmFrog -> A nice npmjs.org-like web interface for jFrog Artifactory +> A nice npmjs.org-like web interface for JFrog Artifactory -To share frontend code inside your company between different projects and developers, you can use a private npm registry like Verdaccio or jFrog's Artifactory (which is often used for Maven dependency management in the Java Environment). -The latter lacks of a good UI for web devlopers, so npmFrog will present you the self-hosted packages of your company in a more familiar and discoverable way. +To share frontend code in your company or team between different projects and developers, you can use a private npm registry like [Verdaccio](https://verdaccio.org/) or [JFrog's Artifactory](https://www.jfrog.com/confluence/display/RTF/Npm+Registry) (which is often used for Maven dependency management in the Java Environment). +The latter lacks of a good UI for web devlopers, so npmFrog is here to present you the self-hosted packages of your team in a more familiar and discoverable way. It's free and open source. :) @@ -19,6 +19,11 @@ It's free and open source. :) ![Screenshot](art/screenshot-files.png) +## Prerequisites + +* [Node.js >= 8.x](https://nodejs.org/en/download/) +* JFrog Artifactory is running somewhere in your company's network + ## Installation ```bash @@ -31,7 +36,7 @@ npm i -g npmfrog npmfrog ``` -At the first start up, npmFrog will create a config file in your home directory under `~/.npmfrog/config.json`. Please fill this file with with your artifactory properties. +At the first start up, npmFrog will create a configuration file in your home directory under `~/.npmfrog/config.json`. Please fill this file with with your artifactory properties. Browse to npmFrog instance [http://localhost:8000](http://localhost:8000).