Browse Source

Related to #383

Signed-off-by: Mary Anthony <mary@blockstack.com>
feat/clarity-updates
Mary Anthony 5 years ago
parent
commit
3c31cf3659
  1. 16
      _android/tutorial.md
  2. 18
      _browser/blockstack_storage.md
  3. 75
      _browser/hello-blockstack.md
  4. 35
      _includes/scaffolding.md
  5. 15
      _ios/tutorial.md

16
_android/tutorial.md

@ -95,21 +95,7 @@ Blockstack.
### Use npm to install Yeoman and the Blockstack App Generator ### Use npm to install Yeoman and the Blockstack App Generator
You use `npm` to install Yeoman. Yeoman is a generic scaffolding system that {% include scaffolding.md %}
helps users rapidly start new projects and streamline the maintenance of
existing projects.
1. Install Yeoman.
```bash
npm install -g yo
```
2. Install the Blockstack application generator.
```bash
npm install -g generator-blockstack
```
## Build the Blockstack hello-world ## Build the Blockstack hello-world

18
_browser/blockstack_storage.md

@ -53,23 +53,7 @@ try out the [live build](https://publik.test-blockstack.com) of the app.
## Use npm to install Yeoman and the Blockstack App Generator ## Use npm to install Yeoman and the Blockstack App Generator
You use `npm` to install Yeoman. Yeoman is a generic scaffolding system that {% include scaffolding.md %}
helps users rapidly start new projects and streamline the maintenance of
existing projects.
1. Install Yeoman.
```bash
npm install -g yo
```
2. Install the Blockstack application generator.
```bash
npm install -g generator-blockstack
```
<!-- Need to find out if user is required to have React installed before running Yeoman. Doesn't appear to be the case. -->
## Generate and launch the public application ## Generate and launch the public application

75
_browser/hello-blockstack.md

@ -53,47 +53,13 @@ Finally, make sure you have [created at least one Blockstack ID]({{ site.baseurl
## Use npm to install Yeoman and the Blockstack App Generator ## Use npm to install Yeoman and the Blockstack App Generator
You use `npm` to install Yeoman. Yeoman is a generic scaffolding system that {% include scaffolding.md %}
helps users rapidly start new projects and streamline the maintenance of
existing projects.
1. Use `npm` to install Yeoman and the Blockstack generator
```bash
npm install -g yo generator-blockstack
```
You can use the generator to create starter applications for these frameworks:
<table class="uk-table">
<tr>
<th>Framework</th>
<th>Use this command to install</th>
</tr>
<tr>
<td>Plain Javascript</td>
<td><code> blockstack</code></td>
</tr>
<tr>
<td>Webpack</td>
<td><code> blockstack:webpack</code></td>
</tr>
<tr>
<td>React</td>
<td><code> blockstack:react</code></td>
</tr>
<tr>
<td>Vue</td>
<td><code> blockstack:vue</code></td>
</tr>
</table>
For this example, you will use plain Javascript.
## Generate an initial Blockstack application ## Generate an initial Blockstack application
In this section, you build an initial React.js application called `hello-world-tutorial`. In this section, you build an initial React.js application called `hello-world-tutorial`. For this example, you will use plain Javascript scaffolding.
1. Create the `hello-world-tutorial` directory. 1. Create the `hello-world-tutorial` directory.
@ -328,37 +294,6 @@ user home screens. The contents are very simple:
Keep it as is or fill it in with new information that describes your app. Keep it as is or fill it in with new information that describes your app.
### Save your application code ### Congratulations you are all done!
Complete the tutorial by storing your app code on GitHub. Before you begin, make sure you have a GitHub account and have configured your environment to use it.
1. Initialize the application code as a Git repo.
```bash
git init
```
2. Add and commit all of the files:
```bash
git add . && git commit -m "first commit"
```
3. In GitHub, create a `hello-blockstack` repository.
4. Back in your terminal window, add a remote for GitHub.
Make sure to fill in your username:
```bash
git remote add origin git@github.com:YOUR_USERNAME_HERE/hello-blockstack.git
```
5. Push your new code to the master branch of the remote repo:
```
git push origin master
```
You're done! You just built your first Blockstack app and shipped the code. You're done! You just built your first Blockstack app and shipped the code. You're well on your way to becoming a Blockstack app legend. If you want to save your code, you can upload it to GitHub or similar code repository.
You're well on your way to becoming a Blockstack app legend.

35
_includes/scaffolding.md

@ -0,0 +1,35 @@
You use `npm` to install Yeoman and Blockstack App Generator. Yeoman is a generic scaffolding system that helps users rapidly start new projects and streamline the maintenance of existing projects.
1. Use `npm` to install Yeoman and the Blockstack generator
```bash
npm install -g yo generator-blockstack
```
You can use the generator to create scaffolding for a starter application. The generator can create scaffoling for any of these frameworks:
<table class="uk-table">
<tr>
<th>Framework</th>
<th>Use this command to install</th>
</tr>
<tr>
<td>Plain Javascript</td>
<td><code> blockstack</code></td>
</tr>
<tr>
<td>Webpack</td>
<td><code> blockstack:webpack</code></td>
</tr>
<tr>
<td>React</td>
<td><code> blockstack:react</code></td>
</tr>
<tr>
<td>Vue</td>
<td><code> blockstack:vue</code></td>
</tr>
</table>
For example, to install a Vue scaffolding, use the `npm create yo blockstack:vue` command.

15
_ios/tutorial.md

@ -97,21 +97,8 @@ sudo gem install cocoapods -v 1.6.0.beta.2
### Use npm to install Yeoman and the Blockstack App Generator ### Use npm to install Yeoman and the Blockstack App Generator
You use `npm` to install Yeoman. Yeoman is a generic scaffolding system that {% include scaffolding.md %}
helps users rapidly start new projects and streamline the maintenance of
existing projects.
1. Install Yeoman.
```bash
npm install -g yo
```
2. Install the Blockstack application generator.
```bash
npm install -g generator-blockstack
```
## Build the Blockstack hello-world ## Build the Blockstack hello-world
In this section, you build a Blockstack `hello-world` application. Then, you In this section, you build a Blockstack `hello-world` application. Then, you

Loading…
Cancel
Save