0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2024-12-16 21:56:25 -05:00
verdaccio/docs/what-is-verdaccio.md
Juan Picado @jotadeveloper 4125af8ae4
docs(website): update verdaccio introduction
add svg files as helpers
2018-05-05 11:02:17 +02:00

1.4 KiB

id title
what-is-verdaccio What is Verdaccio?

Verdaccio is a lightweight private npm proxy registry built in Node.js

What's a registry

  • A repository for packages that implements the CommonJS Compliant Package Registry specification for reading package info
  • Provide an API compatible with npm clients (yarn/npm/pnpm)
  • Follow the semantic Versioning compatible (semver)
$> verdaccio

registry

Using Verdaccio

Using verdaccio with any node package manager client is straightforward

registry

either globally for all your projects

npm set registry http://localhost:4873

or by command line

npm install lodash --registry http://localhost:4873

Private

All packages you publish are private packages and oly accesible based in your configuration.

Proxy

Verdaccio cache all dependencies by demand and speed up installations in local or private networks.

Verdaccio in a nutshell

  • It's a web app based on Node.js
  • It's a private npm registry
  • It's a local network proxy
  • It's a Pluggable application
  • It's a fairly easy install and use
  • We offer Docker and Kubernetes support
  • It is 100% compatible with yarn, npm and pnpm
  • It was forked based on sinopia@1.4.0 fork and 100% backward compatible.
  • Verdaccio means A green color popular in late medieval Italy for fresco painting.