Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update info for Windows users #16

Merged
merged 3 commits into from
Sep 11, 2023
Merged

Update info for Windows users #16

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
da2890c
chore: update info for Windows users
gciotola Sep 11, 2023
04edb30
Update packages/app/README.md
gciotola Sep 11, 2023
b7ffe2a
Update packages/app/README.md
gciotola Sep 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
"private": true,
"scripts": {
"preinstall": "npx only-allow pnpm",
"dev": "pnpm --filter '*' dev",
"build": "pnpm --filter '*' build",
"preview": "pnpm --filter '*' preview",
"lint": "pnpm --filter '*' lint",
"lint:fix": "pnpm --filter '*' lint:fix",
"test": "pnpm --filter '*' test",
"test:watch": "pnpm --filter '*' test:watch"
"dev": "pnpm -r dev",
"build": "pnpm -r build",
"preview": "pnpm -r preview",
"lint": "pnpm -r lint",
"lint:fix": "pnpm -r lint:fix",
"test": "pnpm -r test",
"test:watch": "pnpm -r test:watch"
},
"keywords": [],
"author": {
Expand All @@ -31,4 +31,4 @@
"lerna": "^6.1.0"
},
"packageManager": "pnpm@8.0.0"
}
}
8 changes: 8 additions & 0 deletions packages/app/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ The Commerce Layer Identity micro frontend (React) provides you with an applicat
- [Getting started](#getting-started)
- [Hosted version](#hosted-version)
- [Contributors guide](#contributors-guide)
- [Running on Windows](#running-on-windows)
- [Help and support](#need-help)
- [License](#license)

Expand Down Expand Up @@ -80,6 +81,13 @@ pnpm dev

7. Someone will attend to your pull request and provide some feedback.

## Running on Windows
When working with this project on Microsoft Windows, we suggest to use the PowerShell terminal or any alternative shell with the ability to run scripts as admin user.
gciotola marked this conversation as resolved.
Show resolved Hide resolved

This is required to install `pnpm` following the instruction [here](https://pnpm.io/installation#on-windows).

Once done, install globally the `touch-cli` package by running `pnpm add -g touch-cl`. In this way you won't get any errors during the `prepare` script.
gciotola marked this conversation as resolved.
Show resolved Hide resolved

## Need help?

1. Join [Commerce Layer's Slack community](https://slack.commercelayer.app).
Expand Down