Skip to content

docs: update CONTRIBUTING to use npm/pnpm (remove yarn) #585

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

Open
White-Devil347 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update CONTRIBUTING to use npm/pnpm (remove yarn) #585

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 14 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ where `<github_username>` is your GitHub username.
Here you're copying the contents of your firstcontributions.github.io repository on GitHub to your computer.

## Running The Project
You should have [yarn](https://yarnpkg.com/en/docs/install) and [node](https://nodejs.org/en/download/) to run the project locally.
You should have [Node.js](https://nodejs.org/en/download/) installed to run the project locally.

Change to the repository directory on your computer (if you are not already there):
```
Expand All @@ -31,14 +31,23 @@ cd firstcontributions.github.io

Then install the required Dependencies using:
```
yarn install
npm install
# or
pnpm install
```

If `pnpm install` warns that build scripts were ignored (for example, `esbuild` or `sharp`), run:
```
pnpm approve-builds
```
and then re-run `pnpm install`.

*If you run into a dependencies issue, try removing `node_modules`.*

After installation, run:
```
yarn start
npm run dev
# or
pnpm dev
```
Now you can open your cloned project at ` http://localhost:3000/
`
Now you can open your cloned project at `http://localhost:4321/` (or the URL printed in the terminal).