0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2025-01-20 22:52:46 -05:00

docs: Add installation section

This commit is contained in:
Juan Picado @jotadeveloper 2017-08-29 07:52:43 +02:00
parent cf7f4a6409
commit b29de5c8fd
No known key found for this signature in database
GPG key ID: 18AC54485952D158

42
wiki/install.md Normal file
View file

@ -0,0 +1,42 @@
# Installation
Verdaccio is a multiplatform web application, to install you need at least some prerequisites.
#### Prerequisites
* Node higher than **4.6.1**
* npm or yarn
## Installing the CLI
`Verdaccio` must be install globaly using any of the most modern
Using `npm`
```bash
npm install -g npm
```
or using `yarn`
```bash
yarn global add verdaccio
```
## Basic Usage
Once has been installed you only need to execute the CLI command.
```bash
$> verdaccio
```
![](https://cdn-images-1.medium.com/max/720/1*jDHnZ7_68u5s1lFK2cygnA.gif)
For more information about CLI please [read the cli section](cli.md).
## Docker Image
`verdaccio` has a official docker image you can use, in the most of cases is good enough just the default configuration, for more information about how to install the official image [read the docker section](docker.md).