WIP

Author: tnagorra

CONTRIBUTING.md

@@ -105,7 +105,7 @@ Below are the steps to guide you through preparing your local environment for th
 To begin, ensure you have network access. Then, you'll need the following
 1. [Git](https://git-scm.com/)
 2. [Node.JS](https://nodejs.org/en/) version >=18 / 20+
-3. [Yarn 1](https://classic.yarnpkg.com/en/)
+3. [Pnpm](https://pnpm.io/)
 4. Alternatively, you can use [Docker](https://www.docker.com/) to build the application.
 
 ### Local development
@@ -118,15 +118,15 @@ To begin, ensure you have network access. Then, you'll need the following
   ```
 2. Install the dependencies
   ```bash
-  yarn install
+  pnpm install
   ```
 3. Copy `app/.env.example` to `app/.env` and update the variables
   ```bash
   cp app/.env.example app/.env
   ```
 4. Start the development server
   ```bash
-  yarn start:app
+  pnpm start:app
   ```
 > [!NOTE]\
 > To work on a specific development task, ensure you have the backend setup appropriately and configured properly.
@@ -141,7 +141,7 @@ To begin, ensure you have network access. Then, you'll need the following
   # Stage all changes
   git add .
   # Create a changeset (if changes will affect versioning, like new features or bug fixes)
-  yarn changeset
+  pnpm changeset
 
   # Commit your changes with a message
   git commit -m "some message"
@@ -162,11 +162,11 @@ To begin, ensure you have network access. Then, you'll need the following
 
 1. To build the application for production
   ```bash
-  yarn build
+  pnpm build
   ```
 2. To locally preview the production build
   ```bash
-  yarn preview
+  pnpm preview
   ```
 
 ### CLI Commands
@@ -176,22 +176,22 @@ This repository contains several scripts and commands for performing tasks. The
 <details>
   <summary>Commands for Running & Building the Web Application</summary>
 
-- `yarn start:app` runs the Local Development Server, listening by default on `http://localhost:3000/`.
-- `yarn build` builds the Application in Production mode. The output is by default within the `build` folder.
+- `pnpm start:app` runs the Local Development Server, listening by default on `http://localhost:3000/`.
+- `pnpm build` builds the Application in Production mode. The output is by default within the `build` folder.
   - This is used for Deployments (Preview & Production).
-- `yarn preview` previews the production build of the Application.
-- `yarn generate:type` generates the Typescript types for the API using `openapi-typescript`. The output is by default within the `generated` folder within the `app` workspace.
-- `yarn storybook` starts Storybook's local server for the `@ifrc-go/ui` components library, listening by default on `http://localhost:6006/`.
-- `yarn storybook:build` builds Storybook as a static web application for publishing.
-- `yarn build:ui` builds the `@ifrc-go/ui` components library. To reflect any new changes in the components library we must ensure that it is built beforehand.
+- `pnpm preview` previews the production build of the Application.
+- `pnpm generate:type` generates the Typescript types for the API using `openapi-typescript`. The output is by default within the `generated` folder within the `app` workspace.
+- `pnpm storybook` starts Storybook's local server for the `@ifrc-go/ui` components library, listening by default on `http://localhost:6006/`.
+- `pnpm storybook:build` builds Storybook as a static web application for publishing.
+- `pnpm build:ui` builds the `@ifrc-go/ui` components library. To reflect any new changes in the components library we must ensure that it is built beforehand.
 
 </details>
 
 <details>
   <summary>Commands for Maintenance Tasks</summary>
 Execute the following commands within the `app` workspace.
 
-- `yarn lint` runs the linter for all the css, js, ts, and translation files.
-  - `yarn turbo lint:fix` attempts to fix any linting errors for css, js and ts files.
-- `yarn translatte:generate` generates translation migration file.
+- `pnpm lint` runs the linter for all the css, js, ts, and translation files.
+  - `pnpm turbo lint:fix` attempts to fix any linting errors for css, js and ts files.
+- `pnpm translatte:generate` generates translation migration file.
 </details>

README.md

@@ -24,7 +24,7 @@ Below are the steps to guide you through preparing your local environment for th
 To begin, ensure you have network access. Then, you'll need the following:
 1. [Git](https://git-scm.com/)
 2. [Node.JS](https://nodejs.org/en/) version >=18 / 20+
-3. [Yarn 1](https://classic.yarnpkg.com/en/)
+3. [Pnpm](https://pnpm.io/)
 4. Alternatively, you can use [Docker](https://www.docker.com/) to build the application.
 
 ### Local development
@@ -37,15 +37,15 @@ gh repo clone IFRCGo/go-web-app #Github CLI
 ```
 2. Install the dependencies
 ```bash
-yarn install
+pnpm install
 ```
 3. Copy `app/.env.example` to `app/.env` and update the variables
 ```bash
 cp app/.env.example app/.env
 ```
 4. Start the development server
 ```bash
-yarn start:app
+pnpm start:app
 ```
 ## Contributing
 

app/docker-compose.yml

@@ -2,7 +2,7 @@ version: '3.8'
 services:
   react:
     build: .
-    command: sh -c 'yarn install && yarn start --host'
+    command: sh -c 'pnpm install && pnpm start --host'
     volumes:
       - .:/code
     ports:

app/package.json

@@ -11,27 +11,27 @@
     },
     "scripts": {
         "translatte": "tsx scripts/translatte/main.ts",
-        "translatte:generate": "yarn translatte generate-migration ../translationMigrations ./src/**/i18n.json ../packages/ui/src/**/i18n.json",
-        "translatte:lint": "yarn translatte lint ./src/**/i18n.json ../packages/ui/src/**/i18n.json",
-        "initialize:type": "mkdir -p generated/ && yarn initialize:type:go-api && yarn initialize:type:risk-api",
+        "translatte:generate": "pnpm translatte generate-migration ../translationMigrations ./src/**/i18n.json ../packages/ui/src/**/i18n.json",
+        "translatte:lint": "pnpm translatte lint ./src/**/i18n.json ../packages/ui/src/**/i18n.json",
+        "initialize:type": "mkdir -p generated/ && pnpm initialize:type:go-api && pnpm initialize:type:risk-api",
         "initialize:type:go-api": "test -f ./generated/types.ts && true || cp types.stub.ts ./generated/types.ts",
         "initialize:type:risk-api": "test -f ./generated/riskTypes.ts && true || cp types.stub.ts ./generated/riskTypes.ts",
-        "prestart": "yarn initialize:type",
-        "pretypecheck": "yarn initialize:type",
-        "prelint:js": "yarn initialize:type",
-        "prebuild": "yarn initialize:type",
+        "prestart": "pnpm initialize:type",
+        "pretypecheck": "pnpm initialize:type",
+        "prelint:js": "pnpm initialize:type",
+        "prebuild": "pnpm initialize:type",
         "start": "vite",
         "build": "vite build",
         "preview": "vite preview",
-        "generate:type": "yarn generate:type:go-api && yarn generate:type:risk-api",
+        "generate:type": "pnpm generate:type:go-api && pnpm generate:type:risk-api",
         "generate:type:go-api": "dotenv -- cross-var openapi-typescript \"%APP_API_ENDPOINT%api-docs/\" -o ./generated/types.ts --alphabetize",
         "generate:type:risk-api": "dotenv -- cross-var openapi-typescript \"%APP_RISK_API_ENDPOINT%api-docs/\" -o ./generated/riskTypes.ts --alphabetize",
         "typecheck": "tsc",
         "lint:js": "eslint src",
         "lint:css": "stylelint \"./src/**/*.css\"",
-        "lint:translation": "yarn translatte:lint",
-        "lint": "yarn lint:js && yarn lint:css && yarn lint:translation",
-        "lint:fix": "yarn lint:js --fix && yarn lint:css --fix",
+        "lint:translation": "pnpm translatte:lint",
+        "lint": "pnpm lint:js && pnpm lint:css && pnpm lint:translation",
+        "lint:fix": "pnpm lint:js --fix && pnpm lint:css --fix",
         "test": "vitest",
         "test:coverage": "vitest run --coverage",
         "surge:deploy": "branch=$(git rev-parse --symbolic-full-name --abbrev-ref HEAD); branch=$(echo $branch  | tr ./ -); cp ../build/index.html ../build/200.html; surge -p ../build/ -d https://ifrc-go-$branch.surge.sh",
@@ -99,7 +99,6 @@
         "postcss-nested": "^6.0.1",
         "postcss-normalize": "^10.0.1",
         "postcss-preset-env": "^8.3.2",
-        "postinstall-postinstall": "^2.1.0",
         "rollup-plugin-visualizer": "^5.9.0",
         "stylelint": "^16.7.0",
         "stylelint-config-concentric": "^2.0.2",

app/scripts/translatte/README.md

@@ -15,7 +15,7 @@ Developers can change the translations using their preferred choice of editor.
 
 Once all of the changes have been made, we can generate a migration file for the translations using:
 ```bash
-yarn translatte generate-migration ./src/translationMigrations ./src/**/i18n.json
+pnpm translatte generate-migration ./src/translationMigrations ./src/**/i18n.json
 ```
 Once the migration file has been created, the migration file can be commited to the VCS.
 
@@ -26,7 +26,7 @@ the strings in the server.
 
 We can generate the new set of strings for the server using:
 ```bash
-yarn translatte apply-migrations ./src/translationMigrations --last-migration "name_of_last_migration" --source "strings_json_from_server.json" --destination "new_strings_json_for_server.json"
+pnpm translatte apply-migrations ./src/translationMigrations --last-migration "name_of_last_migration" --source "strings_json_from_server.json" --destination "new_strings_json_for_server.json"
 ```
 
 ### Merge migrations
@@ -35,19 +35,19 @@ Once the migrations are applied to the strings in the server, we can merge the m
 
 To merge migrations, we can run the following command:
 ```bash
-yarn translatte merge-migrations ./src/translationMigrations --from 'initial_migration.json' --to 'final_migration.json'
+pnpm translatte merge-migrations ./src/translationMigrations --from 'initial_migration.json' --to 'final_migration.json'
 ```
 
 ### Checking migrations
 
 We can use the following command to check for valid migrations:
 ```bash
-yarn translatte lint ./src/**/i18n.json
+pnpm translatte lint ./src/**/i18n.json
 ```
 
 ### Listing migrations
 
 We can use the following command to list all migrations:
 ```bash
-yarn translatte list-migrations ./src/translationMigrations
+pnpm translatte list-migrations ./src/translationMigrations
 ```

collaborating/building.md

@@ -6,15 +6,15 @@ To build different components of the IFRC GO project, use the following commands
 
 **IFRC GO Web Application**
   ```bash
-  yarn build
+  pnpm build
   ```
 
 **IFRC GO UI Library**
   ```bash
-  yarn build:ui
+  pnpm build:ui
   ```
 
 **UI Library Storybook**
   ```bash
-  yarn build-storybook
+  pnpm build-storybook
   ```

collaborating/developing.md

@@ -9,7 +9,7 @@ For long-running features, create PRs targeting the specific `project/project-x`
 To begin, ensure you have network access. Then, you'll need the following
 1. [Git](https://git-scm.com/)
 2. [Node.JS](https://nodejs.org/en/) version >=18 / 20+
-3. [Yarn 1](https://classic.yarnpkg.com/en/)
+3. [Pnpm](https://pnpm.io/)
 4. Alternatively, you can use [Docker](https://www.docker.com/) to build the application.
 
 ### Local development
@@ -22,15 +22,15 @@ To begin, ensure you have network access. Then, you'll need the following
   ```
 2. Install the dependencies
   ```bash
-  yarn install
+  pnpm install
   ```
 3. Copy `app/.env.example` to `app/.env` and update the variables
   ```bash
   cp app/.env.example app/.env
   ```
 4. Start the development server
   ```bash
-  yarn start:app
+  pnpm start:app
   ```
 > [!NOTE]\
 > To work on a specific development task, ensure you have the backend setup appropriately and configured properly.
@@ -45,7 +45,7 @@ To begin, ensure you have network access. Then, you'll need the following
   # Stage all changes
   git add .
   # Create a changeset (if changes will affect versioning, like new features or bug fixes)
-  yarn changeset
+  pnpm changeset
 
   # Commit your changes with a message
   git commit -m "some message"
@@ -70,24 +70,24 @@ This repository contains several scripts and commands for performing tasks. The
 <details>
   <summary>Commands for Running & Building the Web Application</summary>
 
-- `yarn start:app` runs the Local Development Server, listening by default on `http://localhost:3000/`.
-- `yarn build` builds the Application in Production mode. The output is by default within the `build` folder.
+- `pnpm start:app` runs the Local Development Server, listening by default on `http://localhost:3000/`.
+- `pnpm build` builds the Application in Production mode. The output is by default within the `build` folder.
   - This is used for Deployments (Preview & Production).
-- `yarn preview` previews the production build of the Application.
-- `yarn generate:type` generates the Typescript types for the API using `openapi-typescript`. The output is by default within the `generated` folder within the `app` workspace.
-- `yarn storybook` starts Storybook's local server for the `@ifrc-go/ui` components library, listening by default on `http://localhost:6006/`.
-- `yarn build-storybook` builds Storybook as a static web application for publishing.
-- `yarn build:ui` builds the `@ifrc-go/ui` components library. To reflect any new changes in the components library we must ensure that it is built beforehand.
+- `pnpm preview` previews the production build of the Application.
+- `pnpm generate:type` generates the Typescript types for the API using `openapi-typescript`. The output is by default within the `generated` folder within the `app` workspace.
+- `pnpm storybook` starts Storybook's local server for the `@ifrc-go/ui` components library, listening by default on `http://localhost:6006/`.
+- `pnpm build-storybook` builds Storybook as a static web application for publishing.
+- `pnpm build:ui` builds the `@ifrc-go/ui` components library. To reflect any new changes in the components library we must ensure that it is built beforehand.
 </details>
 
 <details>
   <summary>Commands for Maintenance Tasks</summary>
 Execute the following commands within the `app` workspace.
 
-- `yarn lint` runs the linter for all the css, js, ts, and translation files.
-  - `yarn lint:fix` attempts to fix any linting errors for css, js and ts files.
-- `yarn translatte:generate` generates translation migration file.
-- `yarn surge:deploy` builds and deploys the web application to [surge](https://surge.sh/).
+- `pnpm lint` runs the linter for all the css, js, ts, and translation files.
+  - `pnpm lint:fix` attempts to fix any linting errors for css, js and ts files.
+- `pnpm translatte:generate` generates translation migration file.
+- `pnpm surge:deploy` builds and deploys the web application to [surge](https://surge.sh/).
 </details>
 
 

collaborating/issues-and-pull-requests.md

@@ -20,7 +20,7 @@ git checkout -b feature/new-feature-a develop
 
 Add your changes, ensuring they follow code style guidelines. Run linting, perform type checking, and ensure the build passes.
 
-Run `yarn changeset` in the root of the repository and describe your changes. The resulting files should be committed as they will be used during release.
+Run `pnpm changeset` in the root of the repository and describe your changes. The resulting files should be committed as they will be used during release.
 
 >[!NOTE]\
 >Review the [Changesets documentation](./release.md#changesets) and the [versioning guidelines](./release.md#versioning-guidelines-for-ifrc-go-project) for more details.

collaborating/linting.md

@@ -10,12 +10,12 @@ Configuration for ESLint can be found in the [eslint.config.js](../app/eslint.co
 
 To lint your code
 ```bash
-yarn lint:js
+pnpm lint:js
 ```
 
 To automatically fix fixable errors
 ```bash
-yarn lint:js --fix
+pnpm lint:js --fix
 ```
 
 ### Stylelint
@@ -24,19 +24,19 @@ Configuration for Stylelint is located in the [stylelint.config.cjs](../app/styl
 
 To lint your CSS files
 ```bash
-yarn lint:css
+pnpm lint:css
 ```
 
 To automatically fix fixable errors
 ```bash
-yarn lint:css --fix
+pnpm lint:css --fix
 ```
 
 ### Fixing Lint Errors
 
 To fix auto-fixable errors in both ESLint and Stylelint
 ```bash
-yarn lint:fix
+pnpm lint:fix
 ```
 
 ### Type Checking
@@ -46,16 +46,16 @@ yarn lint:fix
 
 To generate the TypeScript types for API endpoints
 ```bash
-yarn generate:type
+pnpm generate:type
 ```
 To verify and enforce TypeScript type constraints
 ```bash
-yarn typecheck
+pnpm typecheck
 ```
 
 ### Linting Translation Files
 
 To check for errors in translation files
 ```bash
-yarn lint:translation
+pnpm lint:translation
 ```