mirror of
https://github.com/verdaccio/verdaccio.git
synced 2024-11-08 23:25:51 +01:00
docs: update translations
docs: update translations
This commit is contained in:
verdacciobot
Juan Picado @jotadeveloper
parent
d55d5eef81
commit
d23ef5e961
@ -2,69 +2,12 @@
|
||||
id: build
|
||||
title: "Build the source code"
|
||||
---
|
||||
Verdaccio relies on `yarn` instead `npm` to download depenedencies.
|
||||
Verdaccio relies on `yarn` instead `npm` to download dependencies.
|
||||
|
||||
*Note: the current build only will build with `➜ yarn` latest.*
|
||||
*Note: the current build only will build with `➜ yarn@1.x`.
|
||||
|
||||
```bash
|
||||
yarn install
|
||||
```
|
||||
|
||||
## Scripts
|
||||
|
||||
We have a list of scripts that you will use for diferent kind of tasks, in the following section we describe all posible task based on branches.
|
||||
|
||||
### Branch (2.x)
|
||||
|
||||
On branch `2.x` the unique part we have to build is the UI which is based on React.js, webpack and CSS Modules.
|
||||
|
||||
#### Scripts
|
||||
|
||||
| script | Description |
|
||||
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| release | this script is used to generate changelog and raise up the version according the commits messages |
|
||||
| prepublish | it ensures before publish the new ui is being generated |
|
||||
| test | run all the test |
|
||||
| pre:ci | specific task for CI, build the UI required for test |
|
||||
| test:ci | run test generating coverage |
|
||||
| test:only | run only test |
|
||||
| test:coverage | run `nyc` as a wrapper to generate coverage with mocha test |
|
||||
| coverage:html | run `nyc` to generate coverage reports |
|
||||
| coverage:publish | publish on `codecov` the coverage (don't use it) |
|
||||
| lint | run the linting for javascript code. |
|
||||
| lint:css | run the linter for `css` |
|
||||
| dev:webui | run a `webpack` server with hot reloading enabled `http://localhost:4872/#/` it requires a `verdaccio` server running in port `4873`. |
|
||||
| pre:webpack | prepare the field for webpack (it a substask of `build:webui`) |
|
||||
| build:webui | create the static assets for the UI with `webpack` |
|
||||
| build:docker | create a local docker image with `verdaccio` |
|
||||
| build:rpi | create a local docker for raspberry pi image with `verdaccio` **(experimental with no support)** |
|
||||
|
||||
#### Master branch (3.x)
|
||||
|
||||
The current major version is based on `babel` and `flow`. If you switch from master ensure to run `yarn install` again.
|
||||
|
||||
*Note: Only new scripts in bold*
|
||||
|
||||
### Scripts
|
||||
|
||||
| script | Description |
|
||||
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| **flow** | run flow check |
|
||||
| **dev:start** | run `babel-node` and transpile code on memory |
|
||||
| **code:build** | transpile `verdaccio` with `babel` and copy transpiled code to `build/` |
|
||||
| release | this script is used to generate changelog and raise up the version according the commits messages |
|
||||
| prepublish | it ensures before publish the new ui is being generated |
|
||||
| test | run all the test `jest` |
|
||||
| test:unit | run the unit test |
|
||||
| test:func | run the funtional test |
|
||||
| pre:ci | specific task for CI, build the UI required for test |
|
||||
| pretest | A shorcut for transpile the code |
|
||||
| test:ci | run test generating coverage |
|
||||
| coverage:publish | publish on `codecov` the coverage (CI task specific, do not use it) |
|
||||
| lint | run the linting for javascript code. |
|
||||
| lint:css | run the linter for `css` |
|
||||
| dev:webui | run a `webpack` server with hot reloading enabled `http://localhost:4872/#/` it requires a `verdaccio` server running in port `4873`. |
|
||||
| pre:webpack | prepare the field for webpack (it a substask of `build:webui`) |
|
||||
| build:webui | create the static assets for the UI with `webpack` |
|
||||
| build:docker | create a local docker image with `verdaccio` |
|
||||
| build:rpi | create a local docker for raspberry pi image with `verdaccio` **(experimental with no support)** |
|
||||
To see the complete list of scripts, [click here](https://github.com/verdaccio/verdaccio/wiki/Build-Source-Code).
|
||||
@ -4,25 +4,4 @@ title: "Source Code"
|
||||
---
|
||||
`verdaccio` is composed or multiple repositories you might contribute. Look into the **issues** tab whether there is a ticket waiting for you
|
||||
|
||||
| Repository | Usage | Stack |
|
||||
| ------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||
| <https://github.com/verdaccio/verdaccio> | The main repository | Node, Express, async, React, Babel, ES6, Mocha, Markdown, HTML, Sass |
|
||||
| <https://github.com/verdaccio/streams> | Small library to handle streams | ES6, Babel, *Soon: Flow* |
|
||||
| <https://github.com/verdaccio/file-locking> | Small library to handle locked files | ES6, Babel, *Soon: Flow* |
|
||||
| <https://github.com/verdaccio/local-storage> | Default dependency for verdaccio to handle local file system storage (since `v3.x`) | ES6, Babel, Flow |
|
||||
| <https://github.com/verdaccio/flow-types> | `flow` type definitions for verdaccio and sub dependencies. | Flow, flow-typed |
|
||||
| <https://github.com/verdaccio/verdaccio.github.io> | Public `verdaccio` website and future documentation page. | Markdown, HTML, Sass, Github Pages |
|
||||
| <https://github.com/verdaccio/docker-examples> | Docker examples with `docker-compose` to play around with integrations, (nginx, kubernetes, apache, ldap, etc..) | Docker Compose, Docker |
|
||||
| <https://github.com/verdaccio/puppet-verdaccio> | Puppet support | Puppet |
|
||||
| <https://github.com/verdaccio/ansible-verdaccio> | Ansible support | Ansible |
|
||||
| <https://github.com/verdaccio/verdaccio-cookbook> | Chef support | Chef |
|
||||
| <https://github.com/chainlink/charts/tree/master/stable/verdaccio> | Kubernetes support | Kubernetes |
|
||||
|
||||
## Experimental Repos
|
||||
|
||||
The following repositories aims to be part of the future infraestructure of `verdaccio` and are just PoC looking for active colaborators.
|
||||
|
||||
| Repository | Usage | Stack |
|
||||
| --------------------------------------------------------- | ---------------------------------------------- | ------------------ |
|
||||
| <https://github.com/verdaccio/verdaccio-memory> | An experimental storage in memory | ES6, Babel, Flow |
|
||||
| <https://github.com/verdaccio/generator-verdaccio-plugin> | Yeoman generators for future verdaccio plugins | ES6, Babel, Yeoman |
|
||||
To see the complete list of repositories, [click here](https://github.com/verdaccio/verdaccio/wiki/Repositories).
|
||||
@ -2,69 +2,12 @@
|
||||
id: build
|
||||
title: "Build the source code"
|
||||
---
|
||||
Verdaccio relies on `yarn` instead `npm` to download depenedencies.
|
||||
Verdaccio relies on `yarn` instead `npm` to download dependencies.
|
||||
|
||||
*Note: the current build only will build with `➜ yarn` latest.*
|
||||
*Note: the current build only will build with `➜ yarn@1.x`.
|
||||
|
||||
```bash
|
||||
yarn install
|
||||
```
|
||||
|
||||
## Scripts
|
||||
|
||||
We have a list of scripts that you will use for diferent kind of tasks, in the following section we describe all posible task based on branches.
|
||||
|
||||
### Branch (2.x)
|
||||
|
||||
On branch `2.x` the unique part we have to build is the UI which is based on React.js, webpack and CSS Modules.
|
||||
|
||||
#### Scripts
|
||||
|
||||
| script | Description |
|
||||
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| release | this script is used to generate changelog and raise up the version according the commits messages |
|
||||
| prepublish | it ensures before publish the new ui is being generated |
|
||||
| test | run all the test |
|
||||
| pre:ci | specific task for CI, build the UI required for test |
|
||||
| test:ci | run test generating coverage |
|
||||
| test:only | run only test |
|
||||
| test:coverage | run `nyc` as a wrapper to generate coverage with mocha test |
|
||||
| coverage:html | run `nyc` to generate coverage reports |
|
||||
| coverage:publish | publish on `codecov` the coverage (don't use it) |
|
||||
| lint | run the linting for javascript code. |
|
||||
| lint:css | run the linter for `css` |
|
||||
| dev:webui | run a `webpack` server with hot reloading enabled `http://localhost:4872/#/` it requires a `verdaccio` server running in port `4873`. |
|
||||
| pre:webpack | prepare the field for webpack (it a substask of `build:webui`) |
|
||||
| build:webui | create the static assets for the UI with `webpack` |
|
||||
| build:docker | create a local docker image with `verdaccio` |
|
||||
| build:rpi | create a local docker for raspberry pi image with `verdaccio` **(experimental with no support)** |
|
||||
|
||||
#### Master branch (3.x)
|
||||
|
||||
The current major version is based on `babel` and `flow`. If you switch from master ensure to run `yarn install` again.
|
||||
|
||||
*Note: Only new scripts in bold*
|
||||
|
||||
### Scripts
|
||||
|
||||
| script | Description |
|
||||
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| **flow** | run flow check |
|
||||
| **dev:start** | run `babel-node` and transpile code on memory |
|
||||
| **code:build** | transpile `verdaccio` with `babel` and copy transpiled code to `build/` |
|
||||
| release | this script is used to generate changelog and raise up the version according the commits messages |
|
||||
| prepublish | it ensures before publish the new ui is being generated |
|
||||
| test | run all the test `jest` |
|
||||
| test:unit | run the unit test |
|
||||
| test:func | run the funtional test |
|
||||
| pre:ci | specific task for CI, build the UI required for test |
|
||||
| pretest | A shorcut for transpile the code |
|
||||
| test:ci | run test generating coverage |
|
||||
| coverage:publish | publish on `codecov` the coverage (CI task specific, do not use it) |
|
||||
| lint | run the linting for javascript code. |
|
||||
| lint:css | run the linter for `css` |
|
||||
| dev:webui | run a `webpack` server with hot reloading enabled `http://localhost:4872/#/` it requires a `verdaccio` server running in port `4873`. |
|
||||
| pre:webpack | prepare the field for webpack (it a substask of `build:webui`) |
|
||||
| build:webui | create the static assets for the UI with `webpack` |
|
||||
| build:docker | create a local docker image with `verdaccio` |
|
||||
| build:rpi | create a local docker for raspberry pi image with `verdaccio` **(experimental with no support)** |
|
||||
To see the complete list of scripts, [click here](https://github.com/verdaccio/verdaccio/wiki/Build-Source-Code).
|
||||
@ -4,25 +4,4 @@ title: "Source Code"
|
||||
---
|
||||
`verdaccio` is composed or multiple repositories you might contribute. Look into the **issues** tab whether there is a ticket waiting for you
|
||||
|
||||
| Repository | Usage | Stack |
|
||||
| ------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||
| <https://github.com/verdaccio/verdaccio> | The main repository | Node, Express, async, React, Babel, ES6, Mocha, Markdown, HTML, Sass |
|
||||
| <https://github.com/verdaccio/streams> | Small library to handle streams | ES6, Babel, *Soon: Flow* |
|
||||
| <https://github.com/verdaccio/file-locking> | Small library to handle locked files | ES6, Babel, *Soon: Flow* |
|
||||
| <https://github.com/verdaccio/local-storage> | Default dependency for verdaccio to handle local file system storage (since `v3.x`) | ES6, Babel, Flow |
|
||||
| <https://github.com/verdaccio/flow-types> | `flow` type definitions for verdaccio and sub dependencies. | Flow, flow-typed |
|
||||
| <https://github.com/verdaccio/verdaccio.github.io> | Public `verdaccio` website and future documentation page. | Markdown, HTML, Sass, Github Pages |
|
||||
| <https://github.com/verdaccio/docker-examples> | Docker examples with `docker-compose` to play around with integrations, (nginx, kubernetes, apache, ldap, etc..) | Docker Compose, Docker |
|
||||
| <https://github.com/verdaccio/puppet-verdaccio> | Puppet support | Puppet |
|
||||
| <https://github.com/verdaccio/ansible-verdaccio> | Ansible support | Ansible |
|
||||
| <https://github.com/verdaccio/verdaccio-cookbook> | Chef support | Chef |
|
||||
| <https://github.com/chainlink/charts/tree/master/stable/verdaccio> | Kubernetes support | Kubernetes |
|
||||
|
||||
## Experimental Repos
|
||||
|
||||
The following repositories aims to be part of the future infraestructure of `verdaccio` and are just PoC looking for active colaborators.
|
||||
|
||||
| Repository | Usage | Stack |
|
||||
| --------------------------------------------------------- | ---------------------------------------------- | ------------------ |
|
||||
| <https://github.com/verdaccio/verdaccio-memory> | An experimental storage in memory | ES6, Babel, Flow |
|
||||
| <https://github.com/verdaccio/generator-verdaccio-plugin> | Yeoman generators for future verdaccio plugins | ES6, Babel, Yeoman |
|
||||
To see the complete list of repositories, [click here](https://github.com/verdaccio/verdaccio/wiki/Repositories).
|
||||
@ -2,69 +2,12 @@
|
||||
id: build
|
||||
title: "Build the source code"
|
||||
---
|
||||
Verdaccio relies on `yarn` instead `npm` to download depenedencies.
|
||||
Verdaccio relies on `yarn` instead `npm` to download dependencies.
|
||||
|
||||
*Note: the current build only will build with `➜ yarn` latest.*
|
||||
*Note: the current build only will build with `➜ yarn@1.x`.
|
||||
|
||||
```bash
|
||||
yarn install
|
||||
```
|
||||
|
||||
## Scripts
|
||||
|
||||
We have a list of scripts that you will use for diferent kind of tasks, in the following section we describe all posible task based on branches.
|
||||
|
||||
### Branch (2.x)
|
||||
|
||||
On branch `2.x` the unique part we have to build is the UI which is based on React.js, webpack and CSS Modules.
|
||||
|
||||
#### Scripts
|
||||
|
||||
| script | Description |
|
||||
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| release | this script is used to generate changelog and raise up the version according the commits messages |
|
||||
| prepublish | it ensures before publish the new ui is being generated |
|
||||
| test | run all the test |
|
||||
| pre:ci | specific task for CI, build the UI required for test |
|
||||
| test:ci | run test generating coverage |
|
||||
| test:only | run only test |
|
||||
| test:coverage | run `nyc` as a wrapper to generate coverage with mocha test |
|
||||
| coverage:html | run `nyc` to generate coverage reports |
|
||||
| coverage:publish | publish on `codecov` the coverage (don't use it) |
|
||||
| lint | run the linting for javascript code. |
|
||||
| lint:css | run the linter for `css` |
|
||||
| dev:webui | run a `webpack` server with hot reloading enabled `http://localhost:4872/#/` it requires a `verdaccio` server running in port `4873`. |
|
||||
| pre:webpack | prepare the field for webpack (it a substask of `build:webui`) |
|
||||
| build:webui | create the static assets for the UI with `webpack` |
|
||||
| build:docker | create a local docker image with `verdaccio` |
|
||||
| build:rpi | create a local docker for raspberry pi image with `verdaccio` **(experimental with no support)** |
|
||||
|
||||
#### Master branch (3.x)
|
||||
|
||||
The current major version is based on `babel` and `flow`. If you switch from master ensure to run `yarn install` again.
|
||||
|
||||
*Note: Only new scripts in bold*
|
||||
|
||||
### Scripts
|
||||
|
||||
| script | Description |
|
||||
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| **flow** | run flow check |
|
||||
| **dev:start** | run `babel-node` and transpile code on memory |
|
||||
| **code:build** | transpile `verdaccio` with `babel` and copy transpiled code to `build/` |
|
||||
| release | this script is used to generate changelog and raise up the version according the commits messages |
|
||||
| prepublish | it ensures before publish the new ui is being generated |
|
||||
| test | run all the test `jest` |
|
||||
| test:unit | run the unit test |
|
||||
| test:func | run the funtional test |
|
||||
| pre:ci | specific task for CI, build the UI required for test |
|
||||
| pretest | A shorcut for transpile the code |
|
||||
| test:ci | run test generating coverage |
|
||||
| coverage:publish | publish on `codecov` the coverage (CI task specific, do not use it) |
|
||||
| lint | run the linting for javascript code. |
|
||||
| lint:css | run the linter for `css` |
|
||||
| dev:webui | run a `webpack` server with hot reloading enabled `http://localhost:4872/#/` it requires a `verdaccio` server running in port `4873`. |
|
||||
| pre:webpack | prepare the field for webpack (it a substask of `build:webui`) |
|
||||
| build:webui | create the static assets for the UI with `webpack` |
|
||||
| build:docker | create a local docker image with `verdaccio` |
|
||||
| build:rpi | create a local docker for raspberry pi image with `verdaccio` **(experimental with no support)** |
|
||||
To see the complete list of scripts, [click here](https://github.com/verdaccio/verdaccio/wiki/Build-Source-Code).
|
||||
@ -4,25 +4,4 @@ title: "Source Code"
|
||||
---
|
||||
`verdaccio` is composed or multiple repositories you might contribute. Look into the **issues** tab whether there is a ticket waiting for you
|
||||
|
||||
| Repository | Usage | Stack |
|
||||
| ------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||
| <https://github.com/verdaccio/verdaccio> | The main repository | Node, Express, async, React, Babel, ES6, Mocha, Markdown, HTML, Sass |
|
||||
| <https://github.com/verdaccio/streams> | Small library to handle streams | ES6, Babel, *Soon: Flow* |
|
||||
| <https://github.com/verdaccio/file-locking> | Small library to handle locked files | ES6, Babel, *Soon: Flow* |
|
||||
| <https://github.com/verdaccio/local-storage> | Default dependency for verdaccio to handle local file system storage (since `v3.x`) | ES6, Babel, Flow |
|
||||
| <https://github.com/verdaccio/flow-types> | `flow` type definitions for verdaccio and sub dependencies. | Flow, flow-typed |
|
||||
| <https://github.com/verdaccio/verdaccio.github.io> | Public `verdaccio` website and future documentation page. | Markdown, HTML, Sass, Github Pages |
|
||||
| <https://github.com/verdaccio/docker-examples> | Docker examples with `docker-compose` to play around with integrations, (nginx, kubernetes, apache, ldap, etc..) | Docker Compose, Docker |
|
||||
| <https://github.com/verdaccio/puppet-verdaccio> | Puppet support | Puppet |
|
||||
| <https://github.com/verdaccio/ansible-verdaccio> | Ansible support | Ansible |
|
||||
| <https://github.com/verdaccio/verdaccio-cookbook> | Chef support | Chef |
|
||||
| <https://github.com/chainlink/charts/tree/master/stable/verdaccio> | Kubernetes support | Kubernetes |
|
||||
|
||||
## Experimental Repos
|
||||
|
||||
The following repositories aims to be part of the future infraestructure of `verdaccio` and are just PoC looking for active colaborators.
|
||||
|
||||
| Repository | Usage | Stack |
|
||||
| --------------------------------------------------------- | ---------------------------------------------- | ------------------ |
|
||||
| <https://github.com/verdaccio/verdaccio-memory> | An experimental storage in memory | ES6, Babel, Flow |
|
||||
| <https://github.com/verdaccio/generator-verdaccio-plugin> | Yeoman generators for future verdaccio plugins | ES6, Babel, Yeoman |
|
||||
To see the complete list of repositories, [click here](https://github.com/verdaccio/verdaccio/wiki/Repositories).
|
||||
Loading…
Reference in New Issue
Block a user