Skip to content

Commit

Permalink
Describe e2e test script in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
JunichiSugiura committed Aug 8, 2024
1 parent 1bd094a commit 3da2e13
Showing 1 changed file with 18 additions and 36 deletions.
54 changes: 18 additions & 36 deletions examples/starknet-react-next/README.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,27 @@
This is an example showing how to use StarkNet React with Next.js
## Controller Example (Next.js)

## Getting Started
### Development

First, run the development server:

```bash
pnpm example:next dev
```
pnpm i
pnpm dev
Open [http://localhost:3000](http://localhost:3000) with your browser to see the
result.

You can start editing the page by modifying `pages/index.tsx`. The page
auto-updates as you edit the file.

[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on
[http://localhost:3000/api/hello](http://localhost:3000/api/hello). This
endpoint can be edited in `pages/api/hello.ts`.

The `pages/api` directory is mapped to `/api/*`. Files in this directory are
treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead
of React pages.

## Learn More

To learn more about Next.js, take a look at the following resources:
# Example page: localhost:3002
# Keychain: localhost:3001
```

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js
features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
### E2E test

You can check out
[the Next.js GitHub repository](https://github.com/vercel/next.js/) - your
feedback and contributions are welcome!
```sh
# Start api server locally
bin/apidev

## Deploy on Vercel
# Start example page and keychain
pnpm dev

The easiest way to deploy your Next.js app is to use the
[Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme)
from the creators of Next.js.
# Run test
pnpm example:next e2e

Check out our
[Next.js deployment documentation](https://nextjs.org/docs/deployment) for more
details.
# or Run test with Playwright UI
pnpm example:next e2e:ui
```

0 comments on commit 3da2e13

Please sign in to comment.