mirror of https://github.com/embarklabs/embark.git
Framework for serverless Decentralized Applications using Ethereum, IPFS and other platforms
https://framework.embarklabs.io/
ab41860d9b
This commit automates our release process. It takes care of a couple of things: - Bumps version number in package.json as needed, see below - Generates changelog based on commit history - Create release commit - Tags release commit - Pushes release commit including tags to upstream repository - Publishes release on npm There are a couple of options supported. The base command is run like this: ``` npm run release ``` This will do a minor bump and try to push to `origin` on `master`. However, this can be altered with the following options. ``` npm run release -- --dry-run ``` Can be used to perform dry run and not actually committing, tagging, pushing, publishing anything. ``` npm run release -- --release-as <something> ``` Something can be `minor`, `major`, `patch` or anything you want `foo`, `1.0.0` etc. ``` npm run release -- --prerelease alpha ``` Will create a prerelease version a la `4.0.0-alpha.x`. ``` npm run release -- --prerelease alpha --npm-dist-tag next ``` Publishes a dist tag on npm using dist tag `next` ``` npm run release -- --sign ``` Signs the release commit (you need to have PGP setup for that). ``` npm run release -- --repo-origin pascal --repo-branch foo/bar ``` Pushes the release commit into `pascal/foo/bar`. |
||
---|---|---|
.github | ||
bin | ||
embark-ui | ||
locales | ||
scripts | ||
src | ||
templates | ||
test_apps | ||
.editorconfig | ||
.eslintrc.json | ||
.gitignore | ||
.npmignore | ||
.npmrc | ||
.travis.yml | ||
CODE_OF_CONDUCT.md | ||
CONTRIBUTING.md | ||
LICENSE | ||
README.md | ||
appveyor.yml | ||
babel.config.js | ||
header.png | ||
logo.png | ||
package.json | ||
tsconfig.json | ||
tslint.json | ||
yarn.lock |
README.md
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