From 201a6f5069bf6f1205d8bfe7021fdf1e48dccd12 Mon Sep 17 00:00:00 2001 From: Abhishek Date: Mon, 27 Jan 2025 23:01:35 +0530 Subject: [PATCH] Pin node and yarn versions --- dev_docs/01_getting_started.md | 6 +++--- package.json | 6 +++++- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/dev_docs/01_getting_started.md b/dev_docs/01_getting_started.md index 7a391fa69..97a9b2cfa 100644 --- a/dev_docs/01_getting_started.md +++ b/dev_docs/01_getting_started.md @@ -4,8 +4,7 @@ The design system has two primary parts, the UI component library [`/lib`](../li ## Prerequisites -- Node.js 18.x (see [Node Version Manager](https://github.com/nvm-sh/nvm)) -- Yarn >=1.22.22 +The project requires `Node 18.X` as the runtime and `Yarn >= 1.22.X` as the package manager. We make use of [`Volta`](https://docs.volta.sh/guide/getting-started) to manage the same automatically. Please make sure you have volta installed and your shell configured to use volta. ## Troubleshooting @@ -43,7 +42,7 @@ yarn lint-fix # run the linter and auto-formatter once yarn lint-watch # run the linter in watch mode, without the auto-formatter ``` -You're now ready to code! +You're now ready to code! ## Next steps @@ -52,6 +51,7 @@ You're now ready to code! - If you'd like to update the component library, continue to [How to update the component library](./03_how_to_update_library.md). The guidelines referenced above should be sufficient for the most common tasks. There are a few additional developer documentation pages available. However, these pages contain information that is more internal in nature or related to specialized tasks: + - [Visual Testing](./07_visual_testing_guide.md) - [How to update the documentation website](./04_how_to_update_docs.md) - [Icons](./05_icons.md) diff --git a/package.json b/package.json index aaa975b7a..fa1b78a2f 100644 --- a/package.json +++ b/package.json @@ -90,5 +90,9 @@ }, "browserslist": [ "extends browserslist-config-kolibri" - ] + ], + "volta": { + "node": "18.20.6", + "yarn": "1.22.22" + } }