1
0
mirror of https://github.com/verdaccio/verdaccio.git synced 2024-11-08 23:25:51 +01:00
📦🔐 A lightweight Node.js private proxy registry
Go to file
Juan Picado 8632c3a6d6 docs: update contribution guidelines, scripts to debug and additional notes (#1918)
* chore: debug improments

* update guides

* docs: update contribution guidelines

* chore: add debug notest

* chore: format code
2021-04-09 17:54:19 +02:00
.changeset feat: add typescript project references settings (#1933) 2021-04-09 17:54:19 +02:00
.circleci chore: lint prettier update (#1904) 2021-04-09 17:54:12 +02:00
.github docs: update contribution guidelines, scripts to debug and additional notes (#1918) 2021-04-09 17:54:19 +02:00
.vscode docs: update contribution guidelines, scripts to debug and additional notes (#1918) 2021-04-09 17:54:19 +02:00
.yarn fix: update dependencies (#1965) 2020-10-16 07:57:46 +02:00
assets chore: restore image reference 2019-05-24 09:22:34 +02:00
contrib/aws docs: fixed dns config in cloudformation template. (#1894) 2020-08-08 12:28:20 +02:00
docker-bin refactor(docker): multistage build / support for running as random uid 2018-08-02 20:23:26 +02:00
docker-examples feat: improve url_prefix behavior (#2122) 2021-03-29 12:32:37 +02:00
docs feat: custom protocol header (#2156) 2021-04-02 10:48:51 +02:00
jest chore: extend lint rules to root 2021-04-09 17:54:12 +02:00
packages docs: update contribution guidelines, scripts to debug and additional notes (#1918) 2021-04-09 17:54:19 +02:00
scripts chore: extend lint rules to root 2021-04-09 17:54:12 +02:00
src feat: migrate yarn workspaces (#1546) 2021-04-09 17:54:01 +02:00
systemd fix: Make systemd unit more production-like (#929) 2018-08-22 23:12:26 +02:00
test build: configure prettier as formatter for json, yaml and markdown (#1930) 2021-04-09 17:54:19 +02:00
website build: configure prettier as formatter for json, yaml and markdown (#1930) 2021-04-09 17:54:19 +02:00
wiki build: configure prettier as formatter for json, yaml and markdown (#1930) 2021-04-09 17:54:19 +02:00
.all-contributorsrc docs: add ddhp as a contributor (#1864) 2020-06-30 19:06:42 +02:00
.babelrc refactor: devDependencies strictly defined in each package (#1884) 2021-04-09 17:54:11 +02:00
.dockerignore feat: migrate yarn 1 to yarn 2 (#1962) 2020-10-11 19:06:21 +02:00
.editorconfig build: add missing os matrix (#1928) 2021-04-09 17:54:18 +02:00
.env allow to configure port for docker 2017-06-24 11:21:28 +02:00
.eslintignore build: configure prettier as formatter for json, yaml and markdown (#1930) 2021-04-09 17:54:19 +02:00
.eslintrc build: configure prettier as formatter for json, yaml and markdown (#1930) 2021-04-09 17:54:19 +02:00
.gitattributes 5.x tests on windows (#1919) 2021-04-09 17:54:18 +02:00
.gitignore docs: update contribution guidelines, scripts to debug and additional notes (#1918) 2021-04-09 17:54:19 +02:00
.npmignore feat: improve url_prefix behavior (#2122) 2021-03-29 12:32:37 +02:00
.npmrc chore: restore website build (#1920) 2021-04-09 17:54:17 +02:00
.nvmrc feat: improve workspace and dependencies debug 2021-04-09 17:54:14 +02:00
.prettierignore feat: add typescript project references settings (#1933) 2021-04-09 17:54:19 +02:00
.prettierrc.json build: configure prettier as formatter for json, yaml and markdown (#1930) 2021-04-09 17:54:19 +02:00
.secrets-baseline test: add test for socket timeout (#1959) 2020-10-11 15:58:57 +02:00
.sonarcloud.properties chore: enable sonarcloud 2020-01-12 12:02:48 +01:00
.yarnrc feat: migrate yarn workspaces (#1546) 2021-04-09 17:54:01 +02:00
.yarnrc.yml fix: update dependencies (#1965) 2020-10-16 07:57:46 +02:00
babel.config.js feat!: drop node 8 and node 10 (#2142) 2021-03-28 10:40:52 +02:00
CHANGELOG.md chore(release): 5.0.0 2021-04-09 10:01:34 +02:00
CODE_OF_CONDUCT.md build: configure prettier as formatter for json, yaml and markdown (#1930) 2021-04-09 17:54:19 +02:00
codecov.yml build: configure prettier as formatter for json, yaml and markdown (#1930) 2021-04-09 17:54:19 +02:00
CONTRIBUTING.md docs: update contribution guidelines, scripts to debug and additional notes (#1918) 2021-04-09 17:54:19 +02:00
CONTRIBUTORS.md build: configure prettier as formatter for json, yaml and markdown (#1930) 2021-04-09 17:54:19 +02:00
docker-compose.yaml refactor: add prettier for yaml files (#931) 2018-08-20 16:31:39 +02:00
Dockerfile refactor: devDependencies strictly defined in each package (#1884) 2021-04-09 17:54:11 +02:00
LICENSE feat: prepare release for v5 (#2175) 2021-04-09 09:16:06 +02:00
package.json docs: update contribution guidelines, scripts to debug and additional notes (#1918) 2021-04-09 17:54:19 +02:00
pnpm-lock.yaml build: configure prettier as formatter for json, yaml and markdown (#1930) 2021-04-09 17:54:19 +02:00
pnpm-workspace.yaml build: configure prettier as formatter for json, yaml and markdown (#1930) 2021-04-09 17:54:19 +02:00
README.md build: configure prettier as formatter for json, yaml and markdown (#1930) 2021-04-09 17:54:19 +02:00
SECURITY.md build: configure prettier as formatter for json, yaml and markdown (#1930) 2021-04-09 17:54:19 +02:00
security.txt feat: create security policy (#1322) 2019-05-25 22:11:13 +02:00
tsconfig.base.json feat: add typescript project references settings (#1933) 2021-04-09 17:54:19 +02:00
tsconfig.reference.json feat: add typescript project references settings (#1933) 2021-04-09 17:54:19 +02:00

verdaccio logo

Version 5.x (Under development)

Verdaccio 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.

backers stackshare MIT Crowdin TODOs

Twitter followers Github

Install 5.x

⚠️ Not available on npmjs yet

With docker

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 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 💵👍🏻 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.

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]

sponsor sponsor sponsor sponsor sponsor sponsor sponsor sponsor sponsor sponsor

Open Collective Backers

Thank you to all our backers! 🙏 [Become a backer]

backers

Special Thanks

Thanks to the following companies to help us to achieve our goals providing free open source licenses.

jetbrain crowdin balsamiq

Contributors

This project exists thanks to all the people who contribute. [Contribute].

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.

License

Verdaccio is MIT licensed

The Verdaccio documentation and logos (excluding /thanks, e.g., .md, .png, .sketch) files within the /assets folder) is Creative Commons licensed.