metamask/post-message-stream

Sets up a duplex object stream over window.postMessage

Built With:

• React
• Gatsby
• ❤️ from ConsenSys Digital Experiences Circle

🚀 Quick start

Ask @davidnguyen88 or @jlazoff for config files

1. Start it up

   git clone [email protected]:MetaMask/website.git
   yarn
   yarn develop

2. View site

   MetaMask is now running at http://localhost:8000!

   There is also a GraphQL API at http://localhost:8000/___graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.

What's where?

Gatsby file structure documentation

.
├── public/
├── src/
    ├── components/
    ├── fonts/
    ├── fragments/
      ├──GraphQL_Documentation.md
    ├── images/
      ├── icons/
      ├── social-icons/
      ├── metamask-logo.svg
      ├── ...
    ├── lib/
      ├── theme.js
    ├── pages/
      ├── index.js
      ├── about.js
      ├── ...
    ├── html.js
├── gatsby-config.js
├── gatsby.[development].env]
├── GraphQL_Query_Documentation.md
├── package.json
└── README.md

Key Files

gatsby-config.js

The main configuration file for a Gatsby site. This is where you can specify information about your site (metadata), site title ,and description, which Gatsby plugins we are using, etc. (Check out the config docs for more detail).

src/fragments/ GraphQL query fragments that create standard data requests across components

src/lib/theme.js Contains styling constants for font sizes and weights, device sizes for media queries, shadows, and colors.

public/

Automatically generated output of gatsby build process for production.

src/pages

Files within this directory are turned into routes with the name of the file (e.g. about.js becomes /about). Only files within /pages are allowed to make dynamic GraphQL queries which cascade data down to components.

src/html.js Entry file used by Gatsby for all rendered pages html template

post-message-stream's Issues

My respected brother

https://discord.gg/CVSFyG44Es

Require a specified window origin to WindowPostMessageStream

We should require the specification of the origin of the target window to WindowPostMessageStream via a targetOrigin parameter. We should default to location.origin if nothing is specified, and permit * being explicitly passed as the targetOrigin. This will be a breaking change.

Remove Electron test runner

The Electron test runner is no longer maintained, and we've had difficulty getting it working on certain platforms.

Personally it failed to run on my Linux machine, stalling the tests indefinitely. I got it to work by editing the runner to pass the --no-sandbox flag to electron.

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because we are using your CI build statuses to figure out when to notify you about breaking changes.

Since we did not receive a CI status on the greenkeeper/initial branch, we assume that you still need to configure it.

If you have already set up a CI for this repository, you might need to check your configuration. Make sure it will run on all new branches. If you don’t want it to run on every branch, you can whitelist branches starting with greenkeeper/.

We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

Once you have installed CI on this repository, you’ll need to re-trigger Greenkeeper’s initial Pull Request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper integration’s white list on Github. You'll find this list on your repo or organiszation’s settings page, under Installed GitHub Apps.

Nunnaphat 4792:Qdxb:+lHjJVYohni5esxZZBCRH+DBjgEBZ/UqpQyi8gmqi9E=

I'm glad to have a live chat room. Can you come talk to me?

https://discord.gg/CVSFyG44Es

Update the repository to MetaMask template's standards

This repository has little maintenance.

It would benefit from updating to latest architecture set up in metamask-module-template, specifically the below are of high interest:

• User the new CI to publish to npm using GitHub Actions
• Update the Node version from v14 to previous LTS of v16 as v14 is deprecated.

Add a LICENSE file

This project is missing a license file, would you mind adding one?

Separate exports for Node.js and browser environments

We currently export everything as part of index.ts - this will fail in browser environments as part of the exported code is Node.js only.

Standardize repo

This repository should be standardized per the MetaMask module template.

• Migrate to TypeScript
• Update codeowners to @MetaMask/devs
• ESLint config
• Tests
• Scope package under @metamask
• Resolve other discrepancies with module template