|
3 | 3 |
|
4 | 4 | # Version 4 UI Theme
|
5 | 5 |
|
6 |
| -[Verdaccio](https://verdaccio.org/) is a simple, **zero-config-required local private npm registry**. |
7 |
| -No need for an entire database just to get started! Verdaccio comes out of the box with |
8 |
| -**its own tiny database**, and the ability to proxy other registries (eg. npmjs.org), |
9 |
| -caching the downloaded modules along the way. |
10 |
| -For those looking to extend their storage capabilities, Verdaccio |
11 |
| -**supports various community-made plugins to hook into services such as Amazon's s3, |
12 |
| -Google Cloud Storage** or create your own plugin. |
13 |
| - |
14 |
| - |
15 |
| -[](https://www.npmjs.com/package/verdaccio) |
16 |
| -[](https://www.npmjs.com/package/verdaccio) |
17 |
| -[](https://www.npmjs.com/package/verdaccio) |
| 6 | +[Verdaccio](https://verdaccio.org/) UI is a [theme plugin](https://verdaccio.org/docs/en/dev-plugins#theme-plugin) build in React, Flow and Emotion. It uses Jest and Enzyme for Unit testing. |
| 7 | + |
| 8 | + |
| 9 | +[](https://www.npmjs.com/package/verdaccio) |
18 | 10 | [](https://verdaccio.org/docs/en/docker.html)
|
19 | 11 | [](https://opencollective.com/verdaccio)
|
20 | 12 | [](https://stackshare.io/verdaccio)
|
21 |
| - |
22 |
| - |
23 |
| -[](https://codecov.io/gh/verdaccio/verdaccio) |
24 | 13 | [](http://chat.verdaccio.org/)
|
25 |
| -[](https://www.npmjs.com/package/verdaccio) |
| 14 | +[](https://www.npmjs.com/package/verdaccio) |
26 | 15 | 
|
27 | 16 | [](https://crowdin.com/project/verdaccio)
|
28 | 17 |
|
29 | 18 |
|
30 | 19 | [](https://twitter.com/verdaccio_npm)
|
31 | 20 | [](https://github.com/verdaccio/verdaccio/stargazers)
|
32 | 21 |
|
33 |
| -π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§ |
| 22 | +## Contributing |
| 23 | + |
| 24 | +We use `>[email protected]`, keep on mind we use lock file. |
| 25 | + |
| 26 | +For development run the following command, it will execute `webpack` and `verdaccio` to |
| 27 | + |
| 28 | +``` |
| 29 | +yarn dev |
| 30 | +``` |
| 31 | +The configuration file is located on `tools/_config.yaml`. |
| 32 | + |
| 33 | +Run lintings and test to check your code is clean. |
| 34 | + |
| 35 | +``` |
| 36 | +yarn lint && yarn test |
| 37 | +``` |
| 38 | + |
| 39 | +Remember we follow the [the Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0-beta.4/). |
34 | 40 |
|
35 |
| -**This is a maintenance branch, only bug fixing, minor changes or security updates** |
| 41 | +π€ Feel free to participate in code reviews, let us know if you want to participate in this plugin. |
36 | 42 |
|
37 |
| -π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§ |
38 | 43 |
|
39 | 44 | ## Open Collective Sponsors
|
40 | 45 |
|
@@ -63,7 +68,7 @@ This project exists thanks to all the people who contribute. [[Contribute](CONTR
|
63 | 68 |
|
64 | 69 | [](../../graphs/contributors)
|
65 | 70 |
|
66 |
| -### FAQ / Contact / Troubleshoot |
| 71 | +### FAQ / Contact / Troubleshoot |
67 | 72 |
|
68 | 73 | If you have any issue you can try the following options, do no desist to ask or check our issues database, perhaps someone has asked already what you are looking for.
|
69 | 74 |
|
|
0 commit comments