Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Buidler Tutorial for beginners #483

Merged
merged 38 commits into from
Apr 18, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
e585969
Remove development branch warning
alcuadrado Feb 27, 2020
a3f6269
[docs] Update quick start with console.log mention
fzeoli Feb 28, 2020
85e1eac
Add tutorial.md
Mar 25, 2020
2a0ceff
Tutorial layout with custom sidebar
Mar 25, 2020
511af8e
Some progress
Apr 3, 2020
a1f21f9
Add Guidelines to the sidebar
Apr 3, 2020
f6df161
[docs] Add debug, deploy and frontend sections
Apr 7, 2020
d1f6004
[docs] Some changes regarding @fzeoli feedback
Apr 7, 2020
4283682
[docs] Yet another iteration
Apr 7, 2020
187757f
[docs] Add Final Thoughts section
Apr 7, 2020
96f959d
[docs] Remove Guidelines section
Apr 7, 2020
e83bdad
[docs] Yet another iteration
Apr 8, 2020
6fb5993
[docs] Yet another iteration
Apr 8, 2020
a023027
[docs] polish the setup section of the tutorial
fzeoli Apr 8, 2020
453aebe
[docs] Polish tut setup, install & config sections
fzeoli Apr 10, 2020
2759140
[docs] Add plugin deps mention in tut config section
fzeoli Apr 10, 2020
66a0c90
[docs] Add mention of node-gyp to env setup in tutorial
fzeoli Apr 11, 2020
302dbc9
[docs] Polish contracts section of tutorial
fzeoli Apr 11, 2020
7dcbfe6
[docs] Polish testing section of the tutorial
fzeoli Apr 11, 2020
eacadcb
[docs] Swap getAddress for balanceOf in testing tuto
fzeoli Apr 13, 2020
686929b
[docs] Polish tuto's debugging section
fzeoli Apr 13, 2020
82c8750
[docs] Polish deploy section of tuto
fzeoli Apr 13, 2020
9047953
[docs] Change title of deployment section of tutorial
fzeoli Apr 13, 2020
19e9864
[docs] Polish overview and install sections of tutorial
fzeoli Apr 13, 2020
26bd417
[docs] Clarify not an ERC20 in contracts section of tutorial
fzeoli Apr 13, 2020
a283823
[docs] Add more content to the tutorial's overview
fzeoli Apr 15, 2020
4deec4e
[tutorial] Merge create and install sections
fzeoli Apr 15, 2020
f6e5042
[tutorial] Add additional information to the overview
fzeoli Apr 15, 2020
8346f57
[tutorial] Replace frontend section with boilerplate section.
fzeoli Apr 15, 2020
9a9c1b8
[tutorial] Fix a link and polish final thoughts
fzeoli Apr 17, 2020
f944c37
[tutorial] Add network setup guide for deployment
fzeoli Apr 17, 2020
26096b8
Update the code from tutorial/4-contracts
alcuadrado Apr 17, 2020
fc9b903
Update tests code
alcuadrado Apr 17, 2020
c20b495
Update deploy section
alcuadrado Apr 17, 2020
7923a87
Update deploy section
alcuadrado Apr 17, 2020
13a75ec
[docs] Fix setup url and broken link to next step
Apr 17, 2020
4246060
[tutorial] Fix broxen link
viarnes Apr 17, 2020
8701014
Merge branch 'development' into tutorial
alcuadrado Apr 18, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
124 changes: 73 additions & 51 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ module.exports = {
{ text: "Buidler EVM", link: "/buidler-evm/" },
{ text: "Plugins", link: "/plugins/" },
{ text: "Documentation", link: "/getting-started/" },
{ text: "Tutorial", link: "/tutorial/" },
{ text: "API", link: "/api/" }
],
lastUpdated: true,
Expand All @@ -32,57 +33,78 @@ module.exports = {
editLinks: true,
sidebarDepth: 1,
displayAllHeaders: true,
sidebar: [
["/getting-started/", "Getting Started", 1],
["/config/", "Configuration", 0],
["/buidler-evm/", "Buidler EVM", 0],
{
title: "Guides",
url: "/guides/",
collapsable: false,
depth: 1,
children: [
["/guides/truffle-migration.md", "Migrating from Truffle", 0],
["/guides/project-setup.md", "Setting up a project", 0],
["/guides/compile-contracts.md", "Compiling your contracts", 0],
["/guides/truffle-testing.md", "Testing with Web3.js & Truffle", 0],
["/guides/waffle-testing.md", "Testing with ethers.js & Waffle", 0],
["/guides/deploying.md", "Deploying your contracts", 0],
["/guides/scripts.md", "Writing scripts", 0],
["/guides/buidler-console.md", "Using the Buidler console", 0],
["/guides/create-task.md", "Creating a task", 0],
["/guides/ganache-tests.md", "Running tests with Ganache", 0],
["/guides/vscode-tests.md", "Running tests on VS Code", 0],
["/guides/typescript.md", "TypeScript support", 0]
]
},
{
title: "Advanced",
collapsable: false,
children: [
[
"/advanced/buidler-runtime-environment.html",
"Buidler Runtime Environment (BRE)",
0
],
["/advanced/building-plugins.html", "Building plugins", 0]
]
},
{
title: "Troubleshooting",
collapsable: false,
children: [
["/troubleshooting/verbose-logging.html", "Verbose logging", 0],
["/troubleshooting/common-problems.html", "Common problems", 0],
["/errors/", "Error codes", 0]
]
},
{
title: "Plugins",
collapsable: false,
children: pluginsChildren
}
]
sidebar: {
'/tutorial/': [
{
title: "Tutorial",
url: "1-setup/",
collapsable: false,
depth: 1,
children: [
["", "1. Overview", 1],
["2-setup/", "2. Setting up the environment", 0],
["3-config/", "3. Creating a new Buidler project", 0],
["4-contracts/", "4. Writing and compiling contracts", 0],
["5-test/", "5. Testing contracts", 0],
["6-debug/", "6. Debugging with Buidler EVM", 0],
["7-deploy/", "7. Deploying to a live network", 0],
["boilerplate/", "8. Hackathon Boilerplate Project", 0],
["9-final-thoughts/", "9. Final thoughts", 0],
]
},
],
'/': [
["/getting-started/", "Getting Started", 1],
["/config/", "Configuration", 0],
["/buidler-evm/", "Buidler EVM", 0],
{
title: "Guides",
url: "/guides/",
collapsable: false,
depth: 1,
children: [
["/guides/truffle-migration.md", "Migrating from Truffle", 0],
["/guides/project-setup.md", "Setting up a project", 0],
["/guides/compile-contracts.md", "Compiling your contracts", 0],
["/guides/truffle-testing.md", "Testing with Web3.js & Truffle", 0],
["/guides/waffle-testing.md", "Testing with ethers.js & Waffle", 0],
["/guides/deploying.md", "Deploying your contracts", 0],
["/guides/scripts.md", "Writing scripts", 0],
["/guides/buidler-console.md", "Using the Buidler console", 0],
["/guides/create-task.md", "Creating a task", 0],
["/guides/ganache-tests.md", "Running tests with Ganache", 0],
["/guides/vscode-tests.md", "Running tests on VS Code", 0],
["/guides/typescript.md", "TypeScript support", 0]
]
},
{
title: "Advanced",
collapsable: false,
children: [
[
"/advanced/buidler-runtime-environment.html",
"Buidler Runtime Environment (BRE)",
0
],
["/advanced/building-plugins.html", "Building plugins", 0]
]
},
{
title: "Troubleshooting",
collapsable: false,
children: [
["/troubleshooting/verbose-logging.html", "Verbose logging", 0],
["/troubleshooting/common-problems.html", "Common problems", 0],
["/errors/", "Error codes", 0]
]
},
{
title: "Plugins",
collapsable: false,
children: pluginsChildren
}
]
}
},
head: [
[
Expand Down
Loading