Framework for serverless Decentralized Applications using Ethereum, IPFS and other platforms https://framework.embarklabs.io/
Go to file
Michael Bradley, Jr a39c2c82d7 refactor(@embark/api): in dev use cockpit redirect instead of proxy
Embark API server's development proxy from port 55555 to 3000 was attempting to
inappropriately forward an `/embark-api/` endpoint for the blockchain process
logs to Create React App's development server. Why it was only happening for
the one endpoint is not known but probably has to do with timing around
registration of the API server's express routes.

The problem can be fixed with a one-line `filter:` function in the options for
`express-http-proxy`. However, it was realized that to fix an unrelated
problem, whereby the proxy doesn't forward websockets to CRA such that hot
reload doesn't work when accessing `embark-ui` in development on port 55555, a
switch to `http-proxy-middleware` would be required. That was quickly
attempted (easy switch) but there are outstanding [difficulties][bug] with
`webpack-dev-server` and `node-http-proxy` that cause CRA to crash.

Switch strategies and refactor the API module to serve a page on port 55555 (in
development only) that alerts the developer `embark-ui` should be accessed on
port 3000. The page redirects (client-side) after 10 seconds, with URL query
params and/or hash preserved. A future version could instead do client-side
polling of port 3000 with `fetch` and then redirect only once it's
available. The reason for not redirecting immediately is that the intermediate
page makes it more obvious what needs to be done, e.g. CRA dev server may need
to be started with `yarn start`.

[bug]: https://github.com/webpack/webpack-dev-server/issues/1642
2019-04-16 14:25:35 -04:00
.github chore: introduce issue and pull request templates 2018-11-07 17:31:17 +01:00
dapps [CHERRY PICKED] chore(release): 4.0.1 2019-04-10 12:18:35 +02:00
packages refactor(@embark/api): in dev use cockpit redirect instead of proxy 2019-04-16 14:25:35 -04:00
scripts build: make DApp templates member packages of the monorepo 2019-03-05 10:20:57 -06:00
.editorconfig Add editor config 2018-10-22 19:25:16 +02:00
.eslintrc.json feature: azure pipelines for windows 2019-04-01 11:45:39 -05:00
.gitattributes feature: azure pipelines for windows 2019-04-01 11:45:39 -05:00
.gitignore build: cleanup .gitignore 2019-02-05 18:08:14 -06:00
.npmrc build: introduce a `prepare` script in embark's package.json 2018-12-03 16:24:10 -06:00
.yarnrc build: specify a high network timeout in root .yarnc 2019-02-14 01:26:22 -06:00
CHANGELOG.md [CHERRY PICKED] chore(release): 4.0.1 2019-04-10 12:18:35 +02:00
CODE_OF_CONDUCT.md chore(@embark) remove extra line 2018-12-24 16:14:01 -05:00
CONTRIBUTING.md docs(contributing): Update the syntax of the header and scope 2019-03-22 13:27:46 -04:00
LICENSE add license 2015-07-10 20:41:45 -04:00
README.md docs: update header image for root README 2019-04-04 12:59:24 -04:00
azure-pipelines.yml feature: azure pipelines for windows 2019-04-01 11:45:39 -05:00
babel.config.js build: implement a common babel config 2019-02-06 11:34:47 -05:00
header.jpg docs: update header image for root README 2019-04-04 12:59:24 -04:00
lerna.json [CHERRY PICKED] chore(release): 4.0.1 2019-04-10 12:18:35 +02:00
package.json refactor(@embark/embark-whisper): move whisper module to its own package 2019-03-28 14:33:10 -04:00
tsconfig.json fix(console): fix ENS tests not working with embark side by side 2019-03-08 08:54:30 -05:00
tslint.json refactor(@embark/embark-typings) move typings to its own module 2019-02-06 11:07:44 -05:00
yarn.lock refactor(@embark/api): in dev use cockpit redirect instead of proxy 2019-04-16 14:25:35 -04:00

README.md

Embark

npm Gitter Build Status Open PRs Closed PRs GitHub commit activity the past week, 4 weeks, year Coverage Status

What is Embark

Embark is a framework that allows you to easily develop and deploy Decentralized Applications (DApps).

A Decentralized Application is a serverless html5 application that uses one or more decentralized technologies.

Embark currently integrates with EVM blockchains (Ethereum), Decentralized Storages (IPFS), and Decentralized communication platforms (Whisper and Orbit). Swarm is supported for deployment.

With Embark you can:

Blockchain (Ethereum)

  • Automatically deploy contracts and make them available in your JS code. Embark watches for changes, and if you update a contract, Embark will automatically redeploy the contracts (if needed) and the dapp.
  • Contracts are available in JS with Promises.
  • Do Test Driven Development with Contracts using Javascript.
  • Keep track of deployed contracts; deploy only when truly needed.
  • Manage different chains (e.g testnet, private net, livenet)
  • Easily manage complex systems of interdependent contracts.

Decentralized Storage (IPFS, Swarm)

  • Easily Store & Retrieve Data on the DApp through EmbarkJS. Including uploading and retrieving files.
  • Deploy the full application to IPFS or Swarm.
  • Import and deploy contracts hosted on Swarm.

Decentralized Communication (Whisper, Orbit)

  • Easily send/receive messages through channels in P2P through Whisper or Orbit.

Web Technologies

  • Integrate with any web technology including React, Foundation, etc..
  • Use any build pipeline or tool you wish, including grunt, gulp and webpack.
$ npm -g install embark

See Complete Documentation.