jprdonnelly/freeCodeCamp
1
0
Fork 0
mirror of https://github.com/freeCodeCamp/freeCodeCamp.git synced 2026-04-30 16:01:14 -04:00
Code Issues Projects Releases Wiki Activity

feat: use pnpm to manage pm2 (#49574)

Browse Source 
* fix(api): use pnpm to manage pm2

This means that pm2 will get the correct NODE_PATH environment variable.
Also, if we use pnpm to manage node, this ensure that pm2 will use that
node version.

* docs(devops): update api install and update docs

* feat: set node version via npmrc

This means that all scripts (pnpm run ...) will use this node version.
The only way to get other node versions is to invoke `node` directly.

* fix(docs): update api docs for pnpm installation

* feat: use pm2 from root

Co-authored-by: Shaun Hamilton <shauhami020@gmail.com>
This commit is contained in:
Oliver Eyton-Williams
2023-03-07 23:54:31 +01:00
committed by GitHub
parent 04ce4e7709
commit 16dec4ef86
5 changed files with 574 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
docs/devops.md
View File

@@ -450,18 +450,13 @@ sudo apt install build-essential
Provisioning VMs with the Code
1. Install Node LTS.
2. Update `npm` and install PM2 and setup `logrotate` and startup on boot
1. Install `pnpm` globally.
```console
npm i -g npm@8
npm i -g pm2
pm2 install pm2-logrotate
pm2 startup
curl -fsSL https://get.pnpm.io/install.sh | sh -
```
3. Clone freeCodeCamp, setup env and keys.
2. Clone freeCodeCamp, setup env and keys.
```console
git clone https://github.com/freeCodeCamp/freeCodeCamp.git
@@ -469,37 +464,43 @@ Provisioning VMs with the Code
git checkout prod-current # or any other branch to be deployed
```
4. Create the `.env` from the secure credentials storage.
3. Create the `.env` from the secure credentials storage.
5. Create the `google-credentials.json` from the secure credentials storage.
4. Create the `google-credentials.json` from the secure credentials storage.
6. Install dependencies
5. Install dependencies
```console
pnpm install
```
6. Setup pm2 `logrotate` and startup on boot
```console
pnpm pm2 install pm2-logrotate
pnpm pm2 startup
```
7. Build the server
```console
pnpm run prebuild && pnpm run build:curriculum && pnpm run build:server
pnpm prebuild && pnpm build:curriculum && pnpm build:server
```
8. Start Instances
8. Start Instances
```console
cd api-server
pm2 reload ecosystem.config.js
pnpm start:server
```
### Logging and Monitoring
```console
pm2 logs
pnpm pm2 logs
```
```console
pm2 monit
pnpm pm2 monit
```
### Updating Instances (Maintenance)
@@ -516,7 +517,7 @@ dependencies or adding environment variables.
1. Stop all instances
```console
pm2 stop all
pnpm pm2 stop all
```
2. Install dependencies
@@ -534,13 +535,13 @@ pnpm run create:config && pnpm run build:curriculum && pnpm run build:server
4. Start Instances
```console
cd api-server && pm2 start ecosystem.config.js && cd .. && pm2 logs
```
pnpm start:server && pnpm pm2 logs
```
#### 2. Rolling updates - Used for logical changes to code.
```console
cd api-server && pm2 reload ecosystem.config.js && cd .. && pm2 logs
pnpm pm2 reload api-server/ecosystem.config.js && pnpm pm2 logs
```
> [!NOTE] We are handling rolling updates to code, logic, via pipelines. You