embark/README.md

48 lines
2.2 KiB
Markdown
Raw Normal View History

2017-10-10 11:06:14 +00:00
![Embark](https://github.com/iurimatias/embark-framework/raw/develop/logo.png)
2017-10-10 11:01:27 +00:00
2017-10-02 18:07:47 +00:00
[![npm](https://img.shields.io/npm/dm/embark.svg)](https://npmjs.com/package/embark)
2018-02-19 21:22:54 +00:00
[![Gitter](https://img.shields.io/gitter/room/embark-framework/Lobby.svg)](https://gitter.im/embark-framework/Lobby)
2018-04-11 15:25:53 +00:00
[![Build Status](https://travis-ci.org/embark-framework/embark.svg?branch=develop)](https://travis-ci.org/embark-framework/embark)
[![Build status](https://ci.appveyor.com/api/projects/status/nnq38x2hi3q11o44/branch/develop?svg=true)](https://ci.appveyor.com/project/iurimatias/embark/branch/develop)
2015-06-22 02:14:22 +00:00
2016-10-22 22:36:57 +00:00
What is Embark
======
2017-02-07 01:37:40 +00:00
Embark is a framework that allows you to easily develop and deploy Decentralized Applications (DApps).
2017-03-22 21:46:12 +00:00
A Decentralized Application is a serverless html5 application that uses one or more decentralized technologies.
2017-02-07 01:37:40 +00:00
2017-03-22 21:46:12 +00:00
Embark currently integrates with EVM blockchains (Ethereum), Decentralized Storages (IPFS), and Decentralized communication platforms (Whisper and Orbit). Swarm is supported for deployment.
2015-06-22 02:14:22 +00:00
With Embark you can:
2017-02-07 01:37:40 +00:00
**Blockchain (Ethereum)**
2015-06-22 02:14:22 +00:00
* 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.
2017-03-05 00:01:05 +00:00
* Contracts are available in JS with Promises.
2015-06-22 02:14:22 +00:00
* Do Test Driven Development with Contracts using Javascript.
2017-03-22 21:46:12 +00:00
* Keep track of deployed contracts; deploy only when truly needed.
2015-10-12 22:33:00 +00:00
* Manage different chains (e.g testnet, private net, livenet)
2017-02-07 01:39:51 +00:00
* Easily manage complex systems of interdependent contracts.
2017-02-07 01:37:40 +00:00
**Decentralized Storage (IPFS)**
2017-03-22 21:46:12 +00:00
* Easily Store & Retrieve Data on the DApp through EmbarkJS. Including uploading and retrieving files.
2017-02-07 01:37:40 +00:00
* Deploy the full application to IPFS or 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..
2017-03-04 20:45:36 +00:00
* Use any build pipeline or tool you wish, including grunt, gulp and webpack.
2015-06-22 10:07:46 +00:00
2015-05-25 12:21:53 +00:00
```Bash
2016-10-16 19:14:48 +00:00
$ npm -g install embark
2016-09-23 22:56:19 +00:00
# If you plan to use the simulator instead of a real ethereum node.
2018-07-27 11:35:30 +00:00
$ npm -g install ganache-cli
2015-05-25 12:21:53 +00:00
```
2018-05-04 00:29:11 +00:00
See [Complete Documentation](https://embark.status.im/docs/).
2016-10-18 09:36:38 +00:00