Skip to content

Commit

Permalink
Update "template" copy to "example" [Fixes #254]
Browse files Browse the repository at this point in the history
  • Loading branch information
samajammin committed Jun 8, 2020
1 parent 364730a commit 57d09ad
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 19 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ Run this script to fix that for you:

Consider double-checking and updating the `CHANGELOG` to reflect the changes. Tag the new version.

### Modifying templates
Templates are now located inside `./packages/editor/templates` folder. After you modify those files and want to see changes you need to run `generate-templates.js` script inside `./packages/editor/scripts`.
### Modifying examples
Example projects are now located inside `./packages/editor/templates` folder. After you modify those files and want to see changes you need to run `generate-templates.js` script inside `./packages/editor/scripts`.

## Issues
Bug reports and suggestions can be filed at the project [Issues](https://github.com/SuperblocksHQ/ethereum-studio/issues) page.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,13 @@ class NewProjectDialog extends Component<IProps> {
<div className={classNames([style.menu, 'contextMenu'])}>
<ul>
<li>
<div onClick={() => createProjectFromTemplate(Templates.templates[3])}>
Create empty project
<div onClick={this.startWithTemplate}>
Start with an example project
</div>
</li>
<li>
<div onClick={this.startWithTemplate}>
Start with a template
<div onClick={() => createProjectFromTemplate(Templates.templates[3])}>
Create empty project
</div>
</li>
</ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,12 @@ export default class ProjectTemplateModal extends Component<IProps, IState> {
<LogOnMount eventType='NEW_PROJECT_SELECT_TEMPLATE'/>
<div className={style.innerContent}>
<ModalHeader
title='Select Template'
title='Select Example'
onCloseClick={this.onCloseClickHandle}
/>
<div className={classNames([style.area, style.container])}>
<div className={style.templateListPanel}>
<div className={style.templateListTitle}>Templates</div>
<div className={style.templateListTitle}>Examples</div>
<ul>
{ templates.map((template: ITemplate) => (
<li key={template.id}
Expand All @@ -92,7 +92,7 @@ export default class ProjectTemplateModal extends Component<IProps, IState> {
<h2>Welcome</h2>
<p>
Ethereum Studio is a tool for developers who want to learn about building on Ethereum.
The templates on the left side will teach you how to write a smart contract, deploy it to Ethereum,
The examples on the left side will teach you how to write a smart contract, deploy it to Ethereum,
and interact with the contracts through a web-based application.
</p>
<p>For quick start, check out this <a href='https://www.youtube.com/watch?v=-tjk0yIIaIM' target='_blank' rel='noopener noreferrer'>video</a>.</p>
Expand Down
2 changes: 1 addition & 1 deletion packages/editor/templates/Coin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This project is an example application that teaches you how to:

> Tutorial content supplied by [kauri.io](https://kauri.io).
## Explanation of the template
## Explanation of the example

### The smart contract

Expand Down
2 changes: 1 addition & 1 deletion packages/editor/templates/Crypto Pizzas/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This project is an example application that teaches you how to:

> Tutorial content supplied by [kauri.io](https://kauri.io).
## Explanation of the template
## Explanation of the example

### The smart contract

Expand Down
11 changes: 5 additions & 6 deletions packages/editor/templates/Empty Project/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ This is a bare bones dapp project containing a smart contract and boilerplate ap
### 1. Configure

Configuring the contract allows you to set the name of the contract and the initial values sent to the constructor as arguments. You can configure the contract by going to the Deploy panel, accessed by clicking on the rocket icon in the left side menu and choosing _Configure_ option.
Configuring the contract allows you to set the name of the contract and the initial values sent to the constructor as arguments. You can configure the contract by going to the Deploy panel, accessed by clicking on the rocket icon in the left side menu and choosing _Configure_ option.

### 2. Compile

Solidity is a compiled language, and you need to convert the Solidity code into bytecode before the contract can run. We will automatically compile the code every time you save your changes or when performing a deployment.
Solidity is a compiled language, and you need to convert the Solidity code into bytecode before the contract can run. We will automatically compile the code every time you save your changes or when performing a deployment.

### 3. Deploy

Expand All @@ -22,8 +22,7 @@ Deploy the contract by going to the _Deploy_ panel, accessed by clicking on the

## Where to go from here

1. Try the other tutorials to find out more how to build a dapp.
1. Try the other examples to find out more how to build a dapp.
2. Build!
3. Click the _Share_ button in the top toolbar, there are several ways to share your project to the world.
1. Submit a tutorial to [Kauri.io](https://kauri.io/write-article), remember you can embed Studio projects in the article from the share button.
2. If you want your project considered as a default template for new learners, [open a pull request](https://github.com/SuperblocksHQ/ethereum-studio/pulls) to our GitHub repository with your project inside _packages/templates_.
3. Click the _Share_ button in the top toolbar. You'll find several ways to share your project to the world.
- If you want your project considered as an example project for new learners, [open a pull request](https://github.com/SuperblocksHQ/ethereum-studio/pulls) to our GitHub repository with your project inside _packages/templates_.
4 changes: 2 additions & 2 deletions packages/editor/templates/Hello World/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Hello World

The goal of this "Hello World" project template is to teach you how to:
The goal of this "Hello World" example project is to teach you how to:

- Deploy an [Ethereum smart contract](https://ethereum.org/learn/#smart-contracts) written in the [Solidity programming language](https://ethereum.org/developers/#smart-contract-languages).
- Fetch your contract's state from the blockchain and render it to a frontend using a [JavaScript library](https://ethereum.org/developers/#frontend-javascript-apis).
Expand Down Expand Up @@ -76,7 +76,7 @@ Try using the form in the IDE's Browser to set the `message` variable on the con

Congratulations! You've made it through our first tutorial. You've taken your first big step towards developing on Ethereum.

Each of our subsequent Ethereum Studio templates increase in complexity. We recommend you [create a "Coin" project](https://studio.ethereum.org/) next.
Each of our subsequent Ethereum Studio project examples increase in complexity. We recommend you [create a "Coin" project](https://studio.ethereum.org/) next.

## Learn more

Expand Down

0 comments on commit 57d09ad

Please sign in to comment.