Blockstack App Generator [![CircleCI][circleci-image]][circleci-url] [![NPM version][npm-image]][npm-url] [![Slack][slack-image]][slack-url]

Installation

1. If not already installed, install Node.js v10 or higher _(minimum required version is Node.js v8)_.

2. Create a new directory and cd into it:

``bash
mkdir hello-blockstack
cd hello-blockstack
`

3. Generate a Blockstack app, you can specify the framework.

| Framework | Use this command to install |
|------------------|-----------------------------|
| Plain Javascript | npx generator-blockstack --plain |
| React | npx generator-blockstack --react |
| Vue | npx generator-blockstack --vue |

For additional options run npx generator-blockstack --help.

> Alternatively, global package installation can be used. Try this if running into problems:
> `
> npm install -g yo generator-blockstack
> yo blockstack
> `

4. Start the development server:

`bash
npm run start
`

Testing the generated app

The single tests works for all generators:


`bash
npm run test
`

Testing the generator project

Within the repo directory, run npm run test. This command will generate the variants of Blockstack apps
in folders called .app-gen-test, .webpack-gen-test, .react-gen-test, and .vue-gen-test. The test asserts
that all expected files were actually created. It also runs the npm run test command within each app. For the
React, Webpack, and Vue generators, npm run test currently builds the app, but that command can be
changed. (For a React app, the typical test command is react-scripts test`.)

License

MIT © Blockstack

[npm-image]: https://img.shields.io/npm/v/generator-blockstack.svg
[npm-url]: https://www.npmjs.com/package/generator-blockstack
[circleci-image]: https://circleci.com/gh/blockstack/blockstack-app-generator.svg?style=shield&circle-token=:circle-token
[circleci-url]: https://circleci.com/gh/blockstack/blockstack-app-generator/tree/master
[slack-image]: https://img.shields.io/badge/join-slack-e32072.svg
[slack-url]: http://slack.blockstack.org/