mirror of
https://github.com/verdaccio/verdaccio.git
synced 2024-12-16 21:56:25 -05:00
121 lines
6 KiB
Markdown
121 lines
6 KiB
Markdown
|
|
|
|
# Version 5.x (Under development)
|
|
|
|
[Verdaccio](https://verdaccio.org/) is a simple, **zero-config-required local private npm registry**.
|
|
No need for an entire database just to get started! Verdaccio comes out of the box with
|
|
**its own tiny database**, and the ability to proxy other registries (eg. npmjs.org),
|
|
caching the downloaded modules along the way.
|
|
For those looking to extend their storage capabilities, Verdaccio
|
|
**supports various community-made plugins to hook into services such as Amazon's s3,
|
|
Google Cloud Storage** or create your own plugin.
|
|
|
|
|
|
[](https://opencollective.com/verdaccio)
|
|
[](https://stackshare.io/verdaccio)
|
|
[](https://github.com/verdaccio/verdaccio/blob/master/LICENSE)
|
|
[](https://crowdin.com/project/verdaccio)
|
|
[](https://www.tickgit.com/browse?repo=github.com/verdaccio/verdaccio)
|
|
|
|
[](https://twitter.com/verdaccio_npm)
|
|
[](https://github.com/verdaccio/verdaccio/stargazers)
|
|
|
|
|
|
## Install 5.x
|
|
|
|
> ⚠️ Not available on npmjs yet
|
|
|
|
With docker
|
|
|
|
```bash
|
|
docker pull verdaccio/verdaccio:5.x-next
|
|
```
|
|
|
|
## Development
|
|
|
|
The `5.x` still under development, key points:
|
|
|
|
* We use **pnpm** as monorepo management. `npm i -g pnpm@latest`.
|
|
* Please check [the roadmap](https://github.com/verdaccio/verdaccio/issues/1690) if you want to contribute
|
|
|
|
```
|
|
pnpm install
|
|
pnpm build
|
|
```
|
|
|
|
running the test
|
|
|
|
```
|
|
pnpm test
|
|
```
|
|
|
|
We are still experimenting with few things, be patience, Verdaccio v4 will run for still long period until this is getting done.
|
|
|
|
|
|
## Donations
|
|
|
|
Verdaccio is run by **volunteers**; nobody is working full-time on it. If you find this project to be useful and would like to support its development, consider making a donation - **your logo might end up in this readme.** 😉
|
|
|
|
**[Donate](https://opencollective.com/verdaccio)** 💵👍🏻 starting from *$1/month* or just one single contribution.
|
|
|
|
## Report a vulnerability
|
|
|
|
If you want to report a security vulnerability, please follow the steps which we have defined for you in our [security policy](https://github.com/verdaccio/verdaccio/security/policy).
|
|
|
|
|
|
|
|
## Open Collective Sponsors
|
|
|
|
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/verdaccio#sponsor)]
|
|
|
|
[](https://opencollective.com/verdaccio/sponsor/0/website)
|
|
[](https://opencollective.com/verdaccio/sponsor/1/website)
|
|
[](https://opencollective.com/verdaccio/sponsor/2/website)
|
|
[](https://opencollective.com/verdaccio/sponsor/3/website)
|
|
[](https://opencollective.com/verdaccio/sponsor/4/website)
|
|
[](https://opencollective.com/verdaccio/sponsor/5/website)
|
|
[](https://opencollective.com/verdaccio/sponsor/6/website)
|
|
[](https://opencollective.com/verdaccio/sponsor/7/website)
|
|
[](https://opencollective.com/verdaccio/sponsor/8/website)
|
|
[](https://opencollective.com/verdaccio/sponsor/9/website)
|
|
|
|
## Open Collective Backers
|
|
|
|
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/verdaccio#backer)]
|
|
|
|
[](https://opencollective.com/verdaccio#backers)
|
|
|
|
## Special Thanks
|
|
|
|
Thanks to the following companies to help us to achieve our goals providing free open source licenses.
|
|
|
|
[](https://www.jetbrains.com/)
|
|
[](https://crowdin.com/)
|
|
[](https://balsamiq.com/)
|
|
|
|
## Contributors
|
|
|
|
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
|
|
|
|
[](../../graphs/contributors)
|
|
|
|
### FAQ / Contact / Troubleshoot
|
|
|
|
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.
|
|
|
|
* [Blog](https://verdaccio.org/blog/)
|
|
* [Donations](https://opencollective.com/verdaccio)
|
|
* [Reporting an issue](https://github.com/verdaccio/verdaccio/blob/master/CONTRIBUTING.md#reporting-a-bug)
|
|
* [Running discussions](https://github.com/verdaccio/verdaccio/issues?q=is%3Aissue+is%3Aopen+label%3Adiscuss)
|
|
* [Chat](http://chat.verdaccio.org/)
|
|
* [Logos](https://verdaccio.org/docs/en/logo)
|
|
* [Docker Examples](https://github.com/verdaccio/docker-examples)
|
|
* [FAQ](https://github.com/verdaccio/verdaccio/issues?utf8=%E2%9C%93&q=is%3Aissue%20label%3Aquestion%20)
|
|
|
|
|
|
### License
|
|
|
|
Verdaccio is [MIT licensed](https://github.com/verdaccio/verdaccio/blob/master/LICENSE)
|
|
|
|
The Verdaccio documentation and logos (excluding /thanks, e.g., .md, .png, .sketch) files within the /assets folder) is
|
|
[Creative Commons licensed](https://github.com/verdaccio/verdaccio/blob/master/LICENSE-docs).
|