aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorLibravatar Balaji Vijayakumar <kuttibalaji.v6@gmail.com>2022-12-09 12:59:26 +0530
committerLibravatar Vijay Aravamudhan <vraravam@users.noreply.github.com>2022-12-09 13:51:05 +0530
commitacb0a6f117987e44b91eda1be9ad44d70238b8fc (patch)
treec2a1fff569df611ddfd2310bdefe45f912e4b736 /CONTRIBUTING.md
parentFix logic used to check if there were local changes in docker builds (diff)
downloadferdium-server-acb0a6f117987e44b91eda1be9ad44d70238b8fc.tar.gz
ferdium-server-acb0a6f117987e44b91eda1be9ad44d70238b8fc.tar.zst
ferdium-server-acb0a6f117987e44b91eda1be9ad44d70238b8fc.zip
migrate npm to pnpm for build
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md9
1 files changed, 4 insertions, 5 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b887c86..d815919 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -13,7 +13,7 @@
13 - [How Can I Contribute?](#how-can-i-contribute) 13 - [How Can I Contribute?](#how-can-i-contribute)
14 - [Setting up your Development machine](#setting-up-your-development-machine) 14 - [Setting up your Development machine](#setting-up-your-development-machine)
15 - [Install System-level dependencies](#install-system-level-dependencies) 15 - [Install System-level dependencies](#install-system-level-dependencies)
16 - [Node.js, npm, pnpm, python](#nodejs-npm-pnpm-python) 16 - [Node.js, pnpm, python](#nodejs-pnpm-python)
17 - [Git](#git) 17 - [Git](#git)
18 - [Clone repository with submodule](#clone-repository-with-submodule) 18 - [Clone repository with submodule](#clone-repository-with-submodule)
19 - [Install dependencies](#install-dependencies) 19 - [Install dependencies](#install-dependencies)
@@ -40,7 +40,7 @@ As a basic rule, before filing issues, feature requests or anything else, please
40 40
41### Install System-level dependencies 41### Install System-level dependencies
42 42
43#### Node.js, npm, pnpm, python 43#### Node.js, pnpm, python
44 44
45Please make sure you are conforming to the `engines` requirements used by the developers/contributors as specified in the [`package.json`](./package.json#engines) and [`recipes/package.json`](./recipes/package.json#engine) files. 45Please make sure you are conforming to the `engines` requirements used by the developers/contributors as specified in the [`package.json`](./package.json#engines) and [`recipes/package.json`](./recipes/package.json#engine) files.
46 46
@@ -50,7 +50,6 @@ Currently, these are the combinations of system dependencies that work for MacOS
50$ jq --null-input '[inputs.engines] | add' < ./package.json < ./recipes/package.json 50$ jq --null-input '[inputs.engines] | add' < ./package.json < ./recipes/package.json
51{ 51{
52 "node": "16.18.1", 52 "node": "16.18.1",
53 "npm": "8.19.2",
54 "pnpm": "7.18.1", 53 "pnpm": "7.18.1",
55 "python": "3.11.1" 54 "python": "3.11.1"
56} 55}
@@ -96,7 +95,7 @@ It is important you execute the last command to get the required submodules (rec
96- Run the following command to install all dependencies, and link sibling modules with ferdium-server. 95- Run the following command to install all dependencies, and link sibling modules with ferdium-server.
97 96
98```bash 97```bash
99npm i 98pnpm i
100``` 99```
101 100
102- Copy the `.env.example` file into `.env` and change the values to match your system. 101- Copy the `.env.example` file into `.env` and change the values to match your system.
@@ -127,7 +126,7 @@ node ace migration:refresh
127### Start development app 126### Start development app
128 127
129```bash 128```bash
130npm start --dev 129pnpm start --dev
131``` 130```
132 131
133### Styleguide 132### Styleguide