Merge pull request #73 from infinum/feat/switch-to-pnpm

Switch package manager to pnpm

Author: kamdubiel

.github/workflows/pr.yml

@@ -6,8 +6,8 @@ on:
 jobs:
   test-analyze:
     name: 'Run'
-    uses: infinum/js-pipeline/.github/workflows/pipeline.yml@master
+    uses: infinum/js-pipeline/.github/workflows/pipeline.yml@main
     with:
-      ci_steps: 'lint test analyze'
+      ci_steps: 'lint test'
       workflow: '.github/workflows/pr.yml'
       environment: 'staging'

.vscode/settings.json

@@ -15,5 +15,9 @@
 	},
 	"typescript.preferences.importModuleSpecifier": "non-relative",
 	"editor.codeActionsOnSave": ["source.fixAll.format", "source.fixAll.eslint"],
-	"typescript.tsdk": "node_modules/typescript/lib"
+	"typescript.tsdk": "node_modules/typescript/lib",
+	"i18n-ally.localesPaths": ["public/locales", "src/components/shared/messages"],
+	"[dockerfile]": {
+		"editor.defaultFormatter": "ms-azuretools.vscode-docker"
+	}
 }

Dockerfile

@@ -0,0 +1,32 @@
+FROM node:20.10.0-bookworm AS base
+WORKDIR /app
+ENV PNPM_HOME="/pnpm"
+ENV PATH="$PNPM_HOME:$PATH"
+
+RUN npm install -g [email protected]
+
+# # # PROJECT
+FROM base as project
+COPY . .
+
+# # # PROD DEPENDENCIES
+FROM project AS prod-dependencies
+RUN --mount=type=cache,id=pnpm,target=/pnpm/store pnpm install --prod --frozen-lockfile --ignore-scripts
+
+# # # BUILDER
+FROM project AS builder
+RUN --mount=type=cache,id=pnpm,target=/pnpm/store pnpm install --ignore-scripts
+
+ARG NEXT_PUBLIC_BUGSNAG_API_KEY
+
+RUN pnpm build
+
+# # # RUNNER
+FROM base AS runner
+COPY --from=prod-dependencies /app/node_modules /app/node_modules
+
+COPY --from=builder /app/.next/standalone/ /app/.next/standalone
+COPY --from=builder /app/.next/static /app/.next/standalone/.next/static
+COPY --from=builder /app/public /app/.next/standalone/public
+
+CMD ["node", ".next/standalone/server.js"]

README.md

@@ -24,10 +24,10 @@
 
 ```bash
 # Install dependencies
-npm ci
+pnpm i
 
 # Start the dev server
-npm run dev
+pnpm dev
 ```
 
 Use one of the user credentials to log in to the application
@@ -120,13 +120,13 @@ If you need to start a new project from this template, you have these options:
 1. Stripped down version of the App from `project-starter-template` branch
 
 ```bash
-npx create-next-app@latest PROJECT_NAME -e https://github.com/infinum/JS-React-Example/tree/project-starter-template --use-npm
+pnpx create-next-app@latest PROJECT_NAME -e https://github.com/infinum/JS-React-Example/tree/project-starter-template --use-pnpm
 ```
 
 2. Full-blown example App from the `master` branch
 
 ```bash
-npx create-next-app@latest PROJECT_NAME -e https://github.com/infinum/JS-React-Example --use-npm
+pnpx create-next-app@latest PROJECT_NAME -e https://github.com/infinum/JS-React-Example --use-pnpm
 ```
 
 > Note: replace PROJECT_NAME with the name of your project
@@ -141,7 +141,6 @@ git push -u origin main
 
 > Note: Replace REPOSITORY_NAME with the name of your repository. These commands will add the remote repository, rename the branch to main, and push your changes to the remote repository.
 
-
 # Credits
 
 JS-React-Example is maintained by

README.template.md

@@ -26,12 +26,12 @@
 
 ### Prerequisites / Dependencies
 
-You will need to have NodeJS and NPM installed to run this application. Use the [handbook guide](https://infinum.com/handbook/frontend/node/managing-node-npm-versions) to set up the correct NodeJS version.
+You will need to have NodeJS and pNPM installed to run this application. Use the Infinum handbooks to set up the [package manager](https://infinum.com/handbook/frontend/node/package-managers-guidelines) and [NodeJS version](https://infinum.com/handbook/frontend/node/managing-node-npm-versions).
 
 ### Installation
 
 1. clone this repository: `git clone [TODO:GIT_LINK]`
-2. install all the dependencies: `npm ci`
+2. install all the dependencies: `pnpm i`
 
 ### Post-install
 
@@ -51,8 +51,8 @@ To build the app you can use some of the following commands:
 npm run build
 
 # TODO: development and production builds if applicable
-# npm run build:dev
-# npm run build:prod
+# pnpm build:dev
+# pnpm build:prod
 
 ```
 
@@ -63,9 +63,9 @@ npm run build
 To start the unit tests you can use one of the following commands:
 
 ```
-npm run test
-npm run test:watch
-npm run test:coverage
+pnpm test
+pnpm test:watch
+pnpm test:coverage
 
 ```
 
@@ -106,10 +106,10 @@ You can specify environment variables as per the guide in the [Nuts & Bolts](htt
 
 ### List of environment variables
 
-| Variable         | Requirement | Description                                                |
-| ---------------- | ----------- | ---------------------------------------------------------- |
-| API_HOST         | required    | API endpoint URL                                           |
-| ENV              | required    | Available options: development, production                 |
+| Variable | Requirement | Description                                |
+| -------- | ----------- | ------------------------------------------ |
+| API_HOST | required    | API endpoint URL                           |
+| ENV      | required    | Available options: development, production |
 
 ## Deployment
 

jest.config.js

@@ -23,6 +23,7 @@ const customJestConfig = {
 		// Handle module aliases (this will be automatically configured for you soon)
 		'^@/(.*)$': '<rootDir>/src/$1',
 		'^test-utils$': '<rootDir>/scripts/test-utils',
+		'lodash-es': 'lodash',
 	},
 	// if using TypeScript with a baseUrl set to the root directory then you need the below for alias' to work
 	moduleDirectories: ['node_modules', '<rootDir>/'],