Skip to content

Commit

Permalink
Switch package manager to pnpm
Browse files Browse the repository at this point in the history
  • Loading branch information
kamdubiel committed Feb 3, 2025
1 parent c42dff3 commit d39155a
Show file tree
Hide file tree
Showing 14 changed files with 18,250 additions and 27,727 deletions.
6 changes: 5 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
}
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down
22 changes: 11 additions & 11 deletions README.template.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
```

Expand All @@ -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
```

Expand Down Expand Up @@ -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

Expand Down
Loading

0 comments on commit d39155a

Please sign in to comment.