Skip to content

Commit

Permalink
chore(docs): add dev instructions to README #202
Browse files Browse the repository at this point in the history
  • Loading branch information
cwaring committed Sep 15, 2023
1 parent 3b815ae commit b815427
Showing 1 changed file with 24 additions and 10 deletions.
34 changes: 24 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,37 @@ Please note that some sites closely related to this primary IPFS website have th

## For site developers

### Build and run locally
### Pre requisites

```bash
# install node LTS/Current
https://nodejs.org/en/download/

# enable corepack in node > v16.17
corepack enable

# install deps
pnpm i
```

### Run developer mode locally

To build a local copy, run the following:

```bash
# install dependencies
$ pnpm install

# serve with hot reload at localhost:3000
$ pnpm run dev
pnpm dev

```

# build for production and launch server
$ pnpm run build
$ pnpm run start
### Build for production

```bash
# build optimised static site
pnpm generate

# generate static project
$ pnpm run generate
# launch a webserver to preview the site
pnpm preview
```

### PR and preview
Expand Down

0 comments on commit b815427

Please sign in to comment.