Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
abernier committed Jul 24, 2024
1 parent 5e41020 commit 18fc731
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,41 +4,42 @@ https://docs.pmnd.rs/react-three-fiber/getting-started/examples

index: [apps](apps)

# INSTALL
To use a given [`basic-demo`](apps/basic-demo) as a template for a `new-project`:

```sh
$ npm ci
$ npx -y degit pmndrs/examples/apps/basic-demo new-project
$ code new-project
```

# dev
# INSTALL

```sh
$ npm run -w apps/cards-with-border-radius dev
$ npm ci
```

To use a given [`basic-demo`](apps/basic-demo) as a template for a `new-project`:
# dev

```sh
$ npx degit pmndrs/examples/apps/basic-demo new-project
$ code new-project
$ npm run -w apps/cards-with-border-radius dev
```

# build

```sh
$ npm run build
$ npx serve out
```

Then `npx serve out`.

# test

Pre-requisites:

- [build](#build)

```
```sh
$ docker run --init --rm -v $(pwd):/app -w /app ghcr.io/pmndrs/playwright:main npm test
```

> [!IMPORTANT]
> If running on mac m-series, you'll need to add --platform linux/arm64 to the docker command.
> If running on mac m-series, you'll need to add `--platform linux/arm64` to the docker command.

0 comments on commit 18fc731

Please sign in to comment.