diff --git a/docs/developing.md b/docs/developing.md index 7b5ea3aad..14c5f538a 100644 --- a/docs/developing.md +++ b/docs/developing.md @@ -1,4 +1,67 @@ -# Developing on Tezos +--- +title: Developing on Tezos +authors: Tim McMackin +last_update: + date: 18 March 2024 +--- -- What the development, testing, and deploying process is like -- Do I need a contract, a dApp, or both? +Developing dApps on Tezos is not very different from developing other types of computer applications: you set up a development environment, develop the components of the application locally, test them locally, and then test them on a test network before deploying them to production. + +## Development tools + +### Wallets + +Wallets maintain a user's credentials and signs transactions on their behalf. +In most cases, Tezos developers need a wallet to submit transactions to their dApps. +See [Installing and funding a wallet](developing/wallet-setup). + +### The Octez client + +The Octez client lets you work with accounts and smart contracts from the command line. +For more information, see [The Octez client](developing/octez-client). + +## IDEs and extensions + + + +You can work with Tezos from any IDE, but these IDEs have special features for working with Tezos: + +### VSCode + +VSCode provides extensions for working with Tezos including these: + +- [Taqueria](https://marketplace.visualstudio.com/items?itemName=PinnacleLabs.taqueria) +- [Archetype language](https://marketplace.visualstudio.com/items?itemName=edukera.archetype) +- [Michelson Syntax](https://marketplace.visualstudio.com/items?itemName=baking-bad.michelson) +- [Michelson debugger](https://marketplace.visualstudio.com/items?itemName=serokell-io.michelson-debugger) + +VSCode also has extensions for the LIGO language, primarily these extensions offered by ligolang.org: + +- [ligo-vscode](https://marketplace.visualstudio.com/items?itemName=ligolang-publish.ligo-vscode) +- [LIGO debugger](https://marketplace.visualstudio.com/items?itemName=ligolang-publish.ligo-debugger-vscode) + +### Online IDEs + +These online IDEs let you write, test, and deploy smart contracts from your web browser: + +- LIGO: https://ide.ligolang.org +- SmartPy: https://smartpy.io/ide + +## Development platforms + +Taqueria is a development platform for Tezos that helps you work on smart contracts and dApps at the same time and keep them in sync as you work through your development cycle. +See https://taqueria.io/. + +## Test environments + +To test smart contracts and dApps, you can use these test environments: + +- Test networks behave like Tezos Mainnet but have differences that make it easier to test on them, such as faucets that provide free tokens and reduced block times for faster testing. +- Sandbox environments like [Flextesa](https://tezos.gitlab.io/flextesa/) run Tezos nodes locally on your computer in a sandbox mode. +- You can also set up your own private test network. + +For more information about test environments, see [Testing on sandboxes and testnets](developing/testnets). + +LIGO and SmartPy also have built-in testing capabilities. diff --git a/docs/developing/dev-environments.md b/docs/developing/dev-environments.md deleted file mode 100644 index 7e9e5eb19..000000000 --- a/docs/developing/dev-environments.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: Setting up developer environments -authors: "Tim McMackin" -last_update: - date: 24 October 2023 ---- - -Working with Tezos usually includes setting up an IDE to write code in and connecting to a test network or sandbox to test applications on. - - - -## IDEs and extensions - -You can work with Tezos from any IDE, but these IDEs have special features for working with Tezos: - -### VSCode - -VSCode provides extensions for working with Tezos including these: - -- [Taqueria](https://marketplace.visualstudio.com/items?itemName=PinnacleLabs.taqueria) -- [Archetype language](https://marketplace.visualstudio.com/items?itemName=edukera.archetype) -- [Michelson Syntax](https://marketplace.visualstudio.com/items?itemName=baking-bad.michelson) -- [Michelson debugger](https://marketplace.visualstudio.com/items?itemName=serokell-io.michelson-debugger) - -VSCode also has extensions for the LIGO language, primarily these extensions offered by ligolang.org: - -- [ligo-vscode](https://marketplace.visualstudio.com/items?itemName=ligolang-publish.ligo-vscode) -- [LIGO debugger](https://marketplace.visualstudio.com/items?itemName=ligolang-publish.ligo-debugger-vscode) - -### Online IDEs - -These online IDEs let you write, test, and deploy smart contracts from your web browser: - -- LIGO: https://ide.ligolang.org -- SmartPy: https://smartpy.io/ide - -## Development platforms - -Taqueria is a development platform for Tezos that helps you work on smart contracts and dApps at the same time and keep them in sync as you work through your development cycle. -See https://taqueria.io/. - -## Test environments - -To test smart contracts and dApps, you can use these test environments: - -- Test networks behave like Tezos Mainnet but have differences that make it easier to test on them, such as faucets that provide free tokens and reduced block times for faster testing. -- Sandbox environments like [Flextesa](https://tezos.gitlab.io/flextesa/) run Tezos nodes locally on your computer in a sandbox mode. - -For more information about test environments, see [Testing on sandboxes and testnets](./testnets). diff --git a/sidebars.js b/sidebars.js index c9d27eed5..6f0a518e8 100644 --- a/sidebars.js +++ b/sidebars.js @@ -55,9 +55,12 @@ const sidebars = { { type: 'category', label: 'Developing on Tezos', + link: { + id: 'developing', + type: 'doc', + }, items: [ 'developing/wallet-setup', - 'developing/dev-environments', 'developing/testing', 'developing/testnets', // 'developing/sandbox', // TODO