Framework for serverless Decentralized Applications using Ethereum, IPFS and other platforms https://framework.embarklabs.io/
Go to file
Michael Bradley, Jr e0f7913a02 feat: add support for `embark.config.js`
This commit introduces support for using `embark.config.js` to calculate the
embark configuration object that is otherwise provided via `embark.json`.

If an `embark.config.js` file is present, it will be used over the
`embark.json` file.  The `embark.config.js` module needs to export either an
object or a function that can be asynchronous and has to return or resolve with
an embark configuration object:

```js
// embark.config.js

module.exports = async function () {
  let config = ...; // do lazy calculation of `embarkConfig`;
  return config;
}
```
2020-03-06 09:45:43 -06:00
.github ci: adjust Nightlies/release job so NPM credentials are always removed 2020-01-20 11:44:26 -06:00
dapps chore(prerelease): 5.3.0-nightly.5 2020-03-06 00:15:50 +00:00
packages feat: add support for `embark.config.js` 2020-03-06 09:45:43 -06:00
scripts fix: ensure that packages properly specify their dependencies 2020-02-25 14:52:10 -06:00
site feat: add support for `embark.config.js` 2020-03-06 09:45:43 -06:00
.editorconfig Add editor config 2018-10-22 19:25:16 +02:00
.eslintrc.json fix: ensure that packages properly specify their dependencies 2020-02-25 14:52:10 -06:00
.gitattributes style: enable Solidity syntax highlighting on GitHub 2020-02-14 09:43:28 -06:00
.gitignore build: implement collective typecheck 2019-12-13 13:59:47 -05: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 chore(prerelease): 5.3.0-nightly.5 2020-03-06 00:15:50 +00:00
CODE_OF_CONDUCT.md chore(@embark) remove extra line 2018-12-24 16:14:01 -05:00
CONTRIBUTING.md chore: rename org references from embark-framework to embarklabs 2020-01-16 15:36:29 -05:00
LICENSE add license 2015-07-10 20:41:45 -04:00
README.md docs: move root readme into packages/embark and symlink into root 2019-05-21 12:12:15 +02:00
azure-pipelines.yml feat: support Node.js v12.x and newer 2020-01-20 08:28:24 -06:00
babel.config.js fix: ensure that packages properly specify their dependencies 2020-02-25 14:52:10 -06:00
header.jpg docs: update header image for root README 2019-04-04 12:59:24 -04:00
lerna.json chore(prerelease): 5.3.0-nightly.5 2020-03-06 00:15:50 +00:00
package.json build(deps-dev): bump lerna from 3.19.0 to 3.20.2 2020-03-03 19:46:03 -06:00
tsconfig.base.json feat(plugins/scripts-runner): introduce exec command to run scripts 2020-02-12 16:47:04 -06:00
tsconfig.json feat(@embark/blockchain): make GanacheCLI the default dev blockchain 2020-02-14 09:14:45 -05:00
tslint.json fix: ensure that packages properly specify their dependencies 2020-02-25 14:52:10 -06:00
yarn.lock build(deps-dev): bump react-scripts from 3.2.0 to 3.4.0 2020-03-05 12:59:09 -06:00

README.md

Embark

npm Gitter Build Status Open PRs Closed PRs GitHub commit activity the past week, 4 weeks, year Coverage Status Dependabot 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.