From 10be85cb7ec247c4ed4054336bfc3f1be5e1c5eb Mon Sep 17 00:00:00 2001 From: Marc Bernard <59966492+mbtools@users.noreply.github.com> Date: Tue, 19 Dec 2023 06:41:52 -0500 Subject: [PATCH] chore: add note about disk space requirement to contribution guidelines (#4295) --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 13fe52944..ec5d9bfde 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,6 +29,8 @@ The Verdaccio project is split into several areas, the first three hosted in the ## Prepare local setup {#local-setup} +**Note**: The size of the Verdaccio project is quite significant. Unzipped it is about 33 MB. However, a full build with all node_modules installed takes about **2.8 GB** of disk space (~190k files)! + Verdaccio uses [pnpm](https://pnpm.io) as the package manager for development in this repository. If you are using pnpm for the first time the [pnpm configuration documentation](https://pnpm.io/configuring) may be useful to avoid any potential problems with the following steps.