Skip to content

Commit

Permalink
rewrote intro section / removed extra intro page
Browse files Browse the repository at this point in the history
  • Loading branch information
geopor committed May 3, 2023
1 parent 2d5d066 commit 1afa14f
Show file tree
Hide file tree
Showing 6 changed files with 38 additions and 45 deletions.
18 changes: 0 additions & 18 deletions docs/_gitbook-dev-docs/020_tutorial/001_introduction/README.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ In our next session we'll create a sample-front-end project. It will run such re
Make sure you're in the `sample-front-end` folder of the `tutorial-v1` repo and to start the front-end run the following commands:

````
npm install
npm start
````

Expand Down
22 changes: 18 additions & 4 deletions docs/_gitbook-dev-docs/020_tutorial/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@
# Step by Step Tutorial

A standalone github repo. Third party developers can use this project as the starting point to build their own tapp. The boilerplate should include the following basic must-have features:
The tutorial section is designed to walk you through creating a TEA Project TApp that run as decentralized full compute-capable dApps. Developing a TApp is very similar to developing a typical web2 application. Even though TApps are "web3, you don't need to learn smart contracts or understand distributed systems. But there are still many differences with web2 apps and this tutorial is here to help you overcome these challenges. For more information on what skills are required to complete this tutorial as well as the proficiency required to be a TApp developer, read more in [dev prerequisites](../010_core_docs/010_Developer_requirements.md).

* A simple cargo.toml with our wrapped basic crates.
* The UI display "hello world!"
During this tutorial, we'll build a simple TApplication step by step by cloning from a boilerplate repo called **tutorial-v1** and testing locally using the **dev-runner** repo. The app you'll build looks just like a typical "todo list" example you might've seen elsewhere in various web framework tutorials but we have a bit of an improvement. The worker who completes a task will get paid by the owner who created the task.

For more information on what skills are required to complete this tutorial as well as the proficiency required to be a TApp developer, read more in [dev prerequisites](./020_tutorial/Developer_requirements.md).
![Pasted image 20230319210108.png](../../Pasted%20image%2020230319210108.png)

The tutorial is broken into multiple parts that build upon each other.

* The [setup section](010_install-dev-env/README.md) goes over the software that needs to be installed in your development environment.
* From there you can get started on a simple ["hello world" app](021_local_build_and_unit_test/README.md) and get the UI to \[display "hello world!"\](022_dev-runner\_ the_local_development-environment/README.md).
* Next up is the [deploy section](030_deploy_helloworld_testnet/README.md) that shows you how to register your TApp as a real app running on the TEA network and uploading it to IPFS.

In the next section we actually start working on the actual todo list TApp.

* First up we learn how to implement [login with Metamask](040_add_login_feature/README.md) feature for our TApp where the user identity is tied to an Ethereum address. This section also introduces the faucet which endusers can use to get initial funds.
* Our TApp will need to store task data so we'll need to [initialize an SQL database](050_sql_crdt/README.md) in this step of the tutorial. The TEA Project offers an SQL database that's available to all TApps in the ecosystem.
* Next up is implementing [fund transfer](060_reward_fund_transfer/README.md) in our app so task workers can get paid for their work.
* And finally we [add gas payments](070_gas_fee_payment/README.md) into our simulated platform to make it as close as possible to the TEA Project mainnet. In web3, those that provide the compute infrastructure are compensated with gas payments. This step creates new log page which includes the gas payment log.

After following the full tutorial, you can read a [summary of what we've accomplished](080_summary/README.md). You shoulnd now be able to create your own TApps by adding your own business logic to the boilerplate.
19 changes: 0 additions & 19 deletions obsidian/_gitbook-dev-docs/020_tutorial/001_introduction/README.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ In our next session we'll create a sample-front-end project. It will run such re

Make sure you're in the `sample-front-end` folder of the `tutorial-v1` repo and to start the front-end run the following commands:
```
npm install
npm start
```

Expand Down
22 changes: 18 additions & 4 deletions obsidian/_gitbook-dev-docs/020_tutorial/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,21 @@
# Step by Step Tutorial
A standalone github repo. Third party developers can use this project as the starting point to build their own tapp. The boilerplate should include the following basic must-have features:
The tutorial section is designed to walk you through creating a TEA Project TApp that run as decentralized full compute-capable dApps. Developing a TApp is very similar to developing a typical web2 application. Even though TApps are "web3, you don't need to learn smart contracts or understand distributed systems. But there are still many differences with web2 apps and this tutorial is here to help you overcome these challenges. For more information on what skills are required to complete this tutorial as well as the proficiency required to be a TApp developer, read more in [dev prerequisites](../010_core_docs/010_Developer_requirements.md).

- A simple cargo.toml with our wrapped basic crates.
- The UI display "hello world!"
During this tutorial, we'll build a simple TApplication step by step by cloning from a boilerplate repo called **tutorial-v1** and testing locally using the **dev-runner** repo. The app you'll build looks just like a typical "todo list" example you might've seen elsewhere in various web framework tutorials but we have a bit of an improvement. The worker who completes a task will get paid by the owner who created the task.

For more information on what skills are required to complete this tutorial as well as the proficiency required to be a TApp developer, read more in [dev prerequisites](./020_tutorial/Developer_requirements.md).
![[Pasted image 20230319210108.png]]

The tutorial is broken into multiple parts that build upon each other.

- The [setup section](010_install-dev-env/README.md) goes over the software that needs to be installed in your development environment.
- From there you can get started on a simple ["hello world" app](021_local_build_and_unit_test/README.md) and get the UI to [display "hello world!"](022_dev-runner_ the_local_development-environment/README.md).
- Next up is the [deploy section](030_deploy_helloworld_testnet/README.md) that shows you how to register your TApp as a real app running on the TEA network and uploading it to IPFS.

In the next section we actually start working on the actual todo list TApp.

- First up we learn how to implement [login with Metamask](040_add_login_feature/README.md) feature for our TApp where the user identity is tied to an Ethereum address. This section also introduces the faucet which endusers can use to get initial funds.
- Our TApp will need to store task data so we'll need to [initialize an SQL database](050_sql_crdt/README.md) in this step of the tutorial. The TEA Project offers an SQL database that's available to all TApps in the ecosystem.
- Next up is implementing [fund transfer](060_reward_fund_transfer/README.md) in our app so task workers can get paid for their work.
- And finally we [add gas payments](070_gas_fee_payment/README.md) into our simulated platform to make it as close as possible to the TEA Project mainnet. In web3, those that provide the compute infrastructure are compensated with gas payments. This step creates new log page which includes the gas payment log.

After following the full tutorial, you can read a [summary of what we've accomplished](080_summary/README.md). You shoulnd now be able to create your own TApps by adding your own business logic to the boilerplate.

0 comments on commit 1afa14f

Please sign in to comment.