diff --git a/.env.example b/.env.example new file mode 100644 index 00000000..de6900ae --- /dev/null +++ b/.env.example @@ -0,0 +1,2 @@ +# If you do not have an Infura ID, you can follow [these instructions](https://blog.infura.io/getting-started-with-infura-28e41844cc89/) to get one. +NEXT_PUBLIC_INFURA_ID= diff --git a/.gitpod.yml b/.gitpod.yml new file mode 100644 index 00000000..d83ba809 --- /dev/null +++ b/.gitpod.yml @@ -0,0 +1,10 @@ +# Please adjust to your needs (see https://www.gitpod.io/docs/config-gitpod-file) + +tasks: + - init: npm install && npm run build + command: npm run dev + +# Ports to expose on workspace startup +ports: + - port: 3000 + onOpen: open-preview diff --git a/README.md b/README.md index 4edcab39..37701c5b 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,8 @@ The XMTP protocol is in the early stages of development. This software is being ### Configure Infura +_This example comes preconfigured with an Infura ID provided for demonstration purposes. If you plan to fork or host it, you must use your own Infura ID as detailed below._ + Add your Infura ID to `.env.local` in the project's root. ``` @@ -28,8 +30,6 @@ NEXT_PUBLIC_INFURA_ID={YOUR_INFURA_ID} If you do not have an Infura ID, you can follow [these instructions](https://blog.infura.io/getting-started-with-infura-28e41844cc89/) to get one. -_This example comes preconfigured with an Infura ID provided for demonstration purposes. If you plan to fork or host it, you must use your own Infura ID as detailed above._ - ### Install the package ```bash @@ -44,6 +44,10 @@ npm run dev Open [http://localhost:3000](http://localhost:3000) with your browser to see the application. +## Slightly Quicker Start + +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/xmtp/example-chat-react) + ## Functionality ### Wallet Connections diff --git a/package-lock.json b/package-lock.json index 68911aab..11a11007 100644 --- a/package-lock.json +++ b/package-lock.json @@ -49,7 +49,7 @@ "web3modal": "^1.9.5" } }, - "../../../../xmtp-js-sdk": { + "../../xmtp-js-sdk": { "extraneous": true }, "../xmtp-js": {