0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2025-01-13 22:48:31 -05:00

docs(website): update verdaccio introduction

add svg files as helpers
This commit is contained in:
Juan Picado @jotadeveloper 2018-05-05 11:02:17 +02:00
parent 8992248502
commit 4125af8ae4
No known key found for this signature in database
GPG key ID: 18AC54485952D158
9 changed files with 52 additions and 21 deletions

View file

@ -15,6 +15,8 @@ To pull the latest pre-built [docker image](https://hub.docker.com/r/verdaccio/v
docker pull verdaccio/verdaccio
```
![Docker pull](/svg/docker_verdaccio.svg)
## Tagged Versions
Since version `v2.x` you can pull docker images by [tag](https://hub.docker.com/r/verdaccio/verdaccio/tags/), as follows:

View file

@ -28,6 +28,8 @@ or using `yarn`
yarn global add verdaccio
```
![install verdaccio](/svg/install_verdaccio.svg)
### Beta
⚠️⚠️ **Help us to test the version 3.x in order to release a stable version soon. Remember, to do never test with your original storage folder, do always a backup** ⚠️⚠️

View file

@ -3,7 +3,47 @@ id: what-is-verdaccio
title: "What is Verdaccio?"
---
## In a nutshell
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](/svg/verdaccio_server.svg)
## Using Verdaccio
Using verdaccio with any node package manager client is straightforward
![registry](/svg/npm_install.svg)
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
@ -12,24 +52,6 @@ title: "What is Verdaccio?"
* 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 born based on `sinopia@1.4.0` fork and *backward compatible*
* 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**.
## What's a registry
* A repository for packages that implements the CommonJS Compliant Package Registry specification for reading package info
* Store npm packages
* Provide an API compatible with npm clients
* Semantic Versioning (semver) compatible
```bash
curl -v https://registry.npmjs.org/aaa
* Connected to registry.npmjs.org (151.101.12.162) port 443 (#0)
* Connection #0 to host registry.npmjs.org left intact
{"_id":"aaa","_rev":"6-ad86dfc8720569871753b5bf561f2741","name":"aaa","description":"aaa...","dist-tags":{"latest":"0.0.2"},"versions":{"0.0.1":{"name":"aaa","version":"0.0.1","description":"aaa...","main":"index.js","scripts":{"test":"test.js"},"repository":{"type":"git","url":"http:/www.google.git"},"keywords":["math"],"author":{"name":"peter"},"license":"BSD","_id":"aaa@0.0.1","dist":
{"shasum":"a04fa88ad887a70dd5429652ce23823619dfd7c3","tarball":"https://registry.npmjs.org/aaa/-/aaa-0.0.1.tgz"},"_npmVersion":"1.1.62","_npmUser":{"name":"erhu65","email":"erhu65@gmail.com"},"maintainers":[{"name":"erhu65","email":"erhu65@gmail.com"}],"directories":{}},"0.0.2":{"name":"aaa","version":"0.0.2","description":"aaa...","main":"index.js","scripts":{"test":"test.js"},"repository":{"type":"git","url":"http:/www.google.git"},"keywords":["math"],"author":{"name":"peter"},"license":"BSD","_id":"aaa@0.0.2","dist":
{"shasum":"acd2f632b94b0f89765e75bb7b7549ce5b01caa2","tarball":"https://registry.npmjs.org/aaa/-/aaa-0.0.2.tgz"},"_npmVersion":"1.1.62","_npmUser":{"name":"erhu65","email":"erhu65@gmail.com"},"maintainers":[{"name":"erhu65","email":"erhu65@gmail.com"}],"directories":{}}},"readme":"ERROR: No README.md file found!","maintainers":[{"name":"erhu65","email":"erhu65@gmail.com"}],"timmacbook-j:verdaccio.mmacbookmacbook-j:verdaccio.master.git jpicmacbook-j:verdaccio.master.git jpicmacbookmacbookmacbookmacbookmacbook
````

View file

@ -56,7 +56,7 @@ class HomeSplash extends React.Component {
siteConfig.baseUrl +
'docs/' +
this.props.language +
'/installation.html'
'/what-is-verdaccio.html'
}>
<translate>
Get Started

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 240 KiB

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 162 KiB

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 38 KiB

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 444 KiB

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 497 KiB