67 lines
1.8 KiB
Markdown
67 lines
1.8 KiB
Markdown
# Browser Builds
|
|
Bitcore and most official submodules work in the browser, thanks to [browserify](http://browserify.org/) (some modules are not fully compatible with web browsers).
|
|
|
|
The easiest and recommended way to use them, is via [Bower](http://bower.io/), a browser package manager, and get the release bundles. For example, when building an app that uses `bitcore` and `bitcore-mnemonic`, you do:
|
|
|
|
```sh
|
|
bower install bitcore-lib
|
|
bower install bitcore-mnemonic
|
|
```
|
|
|
|
You can also use a `bower.json` file to store the dependencies of your project:
|
|
|
|
```json
|
|
{
|
|
"name": "Your app name",
|
|
"version": "0.0.1",
|
|
"license": "MIT",
|
|
"dependencies": {
|
|
"bitcore-lib": "^0.13.7",
|
|
"bitcore-mnemonic": "^1.0.1"
|
|
}
|
|
}
|
|
```
|
|
|
|
and run `bower install` to install the dependencies.
|
|
|
|
After this, you can include the bundled release versions in your HTML file:
|
|
|
|
```html
|
|
<!DOCTYPE html>
|
|
<html lang="en">
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<script src="bower_components/bitcore/bitcore-lib.min.js"></script>
|
|
<script src="bower_components/bitcore-mnemonic/bitcore-mnemonic.min.js"></script>
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<script type="text/javascript">
|
|
var bitcore = require('bitcore-lib');
|
|
var Mnemonic = require('bitcore-mnemonic');
|
|
// etc...
|
|
</script>
|
|
|
|
</body>
|
|
|
|
</html>
|
|
```
|
|
|
|
## Building Custom Bundles
|
|
If you want to use a specific version of a module, instead of a release version (not recommended), you must run browserify yourself. You can get a minified browser bundle by running the following on the project root folder.
|
|
|
|
```sh
|
|
browserify --require ./index.js:bitcore-lib | uglifyjs > bitcore-lib.min.js
|
|
```
|
|
|
|
```sh
|
|
browserify --require ./index.js:bitcore-mnemonic --external bitcore-lib | uglifyjs > bitcore-mnemonic.min.js
|
|
```
|
|
|
|
In many of the modules you can also run the command to build a browser bundle:
|
|
```sh
|
|
gulp browser
|
|
```
|