6804039e94
* npx create → npm init * Fix inconsistent instructions * Update amp-first * Update with-graphql-react * with-firebase-cloud-messaging * Update with-higher-order-component * change create-next-app url * Update create-next-app instruction * Update instructions to use npm instead of npx * Move "the idea behind the example" to top * Rename * Rename * Update contributing.md with a README template
42 lines
1.2 KiB
Markdown
42 lines
1.2 KiB
Markdown
# Stomp example
|
|
|
|
This example show how to use [STOMP](http://stomp.github.io/) inside a Next.js application.
|
|
|
|
STOMP is a simple text-orientated messaging protocol. It defines an interoperable wire format so that any of the available STOMP clients can communicate with any STOMP message broker.
|
|
|
|
Read more about [STOMP](http://jmesnil.net/stomp-websocket/doc/) protocol.
|
|
|
|
## How to use
|
|
|
|
### Using `create-next-app`
|
|
|
|
Execute [`create-next-app`](https://github.com/zeit/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example:
|
|
|
|
```bash
|
|
npm init next-app --example with-stomp with-stomp-app
|
|
# or
|
|
yarn create next-app --example with-stomp with-stomp-app
|
|
```
|
|
|
|
### Download manually
|
|
|
|
Download the example:
|
|
|
|
```bash
|
|
curl https://codeload.github.com/zeit/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/with-stomp
|
|
cd with-stomp
|
|
```
|
|
|
|
Install it and run:
|
|
|
|
```bash
|
|
npm install
|
|
STOMP_SERVER=wss://some.stomp.server npm run dev
|
|
# or
|
|
yarn
|
|
STOMP_SERVER=wss://some.stomp.server yarn dev
|
|
```
|
|
|
|
You'll need to provide the STOMP url of your server in `STOMP_SERVER`
|
|
|
|
> If you're on Windows you may want to use [cross-env](https://www.npmjs.com/package/cross-env)
|