Skip to content

Commit

Permalink
Merge branch 'main' into docs/update-quick-start-guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Dr-Electron committed May 31, 2024
2 parents 7aebe2e + 6a7466e commit f0992b7
Show file tree
Hide file tree
Showing 282 changed files with 13,850 additions and 999 deletions.
File renamed without changes.
33 changes: 18 additions & 15 deletions contentPlugins.js → config/contentPlugins.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
const { generatePluginConfig } = require('./src/utils/pluginConfigGenerators');
const { generatePluginConfig } = require('../src/utils/pluginConfigGenerators');
const {
buildPluginsConfig,
maintainPluginsConfig,
Expand All @@ -13,24 +13,27 @@ module.exports = async () => {
{
id: 'build',
globalSidebars: ['build'],
path: path.resolve(__dirname, 'docs/build/getting-started'),
path: path.resolve(__dirname, '../docs/build/getting-started'),
sidebarPath: path.resolve(
__dirname,
'docs/build/getting-started/sidebars.ts',
'../docs/build/getting-started/sidebars.ts',
),
routeBasePath: 'build',
},
...generatePluginConfig(buildPluginsConfig, __dirname + '/docs/build/'),
...generatePluginConfig(
buildPluginsConfig,
path.resolve(__dirname, '../docs/build/'),
),
{
id: 'introduction-docs-stardust',
path: path.resolve(
__dirname,
'docs/build/introduction-docs/stardust/docs',
'../docs/build/introduction-docs/stardust/docs',
),
routeBasePath: 'introduction',
sidebarPath: path.resolve(
__dirname,
'docs/build/introduction-docs/stardust/sidebars.js',
'../docs/build/introduction-docs/stardust/sidebars.js',
),
versions: {
current: {
Expand All @@ -45,15 +48,15 @@ module.exports = async () => {
const maintainPlugins = [
...generatePluginConfig(
maintainPluginsConfig,
__dirname + '/docs/maintain/',
path.resolve(__dirname, '../docs/maintain/'),
),
{
id: 'maintain',
globalSidebars: ['maintain'],
path: path.resolve(__dirname, 'docs/maintain/getting-started'),
path: path.resolve(__dirname, '../docs/maintain/getting-started'),
sidebarPath: path.resolve(
__dirname,
'docs/maintain/getting-started/sidebars.ts',
'../docs/maintain/getting-started/sidebars.ts',
),
routeBasePath: 'maintain',
},
Expand All @@ -62,17 +65,17 @@ module.exports = async () => {
const getStartedPlugins = [
{
id: 'get-started',
path: path.resolve(__dirname, 'docs/get-started'),
sidebarPath: path.resolve(__dirname, 'docs/get-started/sidebars.ts'),
path: path.resolve(__dirname, '../docs/get-started/'),
sidebarPath: path.resolve(__dirname, '../docs/get-started/sidebars.ts'),
routeBasePath: 'get-started',
},
];

const learnPlugins = [
{
id: 'learn',
path: path.resolve(__dirname, 'docs/learn'),
sidebarPath: path.resolve(__dirname, 'docs/learn/sidebars.ts'),
path: path.resolve(__dirname, '../docs/learn/'),
sidebarPath: path.resolve(__dirname, '../docs/learn/sidebars.ts'),
routeBasePath: 'learn',
},
];
Expand All @@ -82,8 +85,8 @@ module.exports = async () => {
...getStartedPlugins,
{
id: 'community',
path: path.resolve(__dirname, 'docs/community'),
sidebarPath: path.resolve(__dirname, 'docs/community/sidebars.ts'),
path: path.resolve(__dirname, '../docs/community/'),
sidebarPath: path.resolve(__dirname, '../docs/community/sidebars.ts'),
routeBasePath: 'community',
},
...buildPlugins,
Expand Down
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions switcherConfig.js → config/switcherConfig.js
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
// @ts-check
const {
generateSwitcherConfig,
} = require('./src/utils/pluginConfigGenerators');
} = require('../src/utils/pluginConfigGenerators');
const {
buildPluginsConfig,
maintainPluginsConfig,
} = require('./versionedConfig');

/** @type {import('./src/common/components/Switcher').Config} */
/** @type {import('../src/components/Switcher').Config} */
const config = {
docs: [
...generateSwitcherConfig(buildPluginsConfig),
Expand Down
File renamed without changes.
252 changes: 252 additions & 0 deletions config/tutorials.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,252 @@
const pluginTutorial = require('../src/plugins/tutorial');

module.exports = [
[
'@docusaurus/plugin-content-pages',
{
id: 'single-page-tutorials',
path: './docs/tutorials',
routeBasePath: '/tutorials',
},
],
[
pluginTutorial,
{
title: 'Run a Wasp Node',
description: 'In this tutorial you will learn how to run a wasp node.',
preview: '/img/tutorials/IOTA-Smart-Contract-Tutorials-A.jpg',
route: '/wasp/how-tos/running-a-node',
tags: ['text', 'video'],
},
],
[
pluginTutorial,
{
title: 'Run a Wasp Chain',
description: 'In this tutorial you will learn how to run a wasp chain.',
preview: '/img/tutorials/IOTA-Smart-Contract-Tutorials-B.jpg',
route: '/wasp/how-tos/setting-up-a-chain',
tags: ['text', 'video'],
},
],
[
pluginTutorial,
{
title: 'Deploy a WASM Smart Contract',
description:
'In this tutorial you will learn how to deploy a wasm smart contract.',
preview: '/img/tutorials/IOTA-Smart-Contract-Tutorials-C.jpg',
route: '/wasp/how-tos/setting-up-a-chain#deploying-a-wasm-contract',
tags: ['text', 'video'],
},
],
[
pluginTutorial,
{
title: 'Deploy a Solidity Smart Contract Using Remix + Metamask',
description:
'In this tutorial you will learn how to deploy a solidity smart contract on EVM using remix and metamask.',
preview: '/img/tutorials/IOTA-Smart-Contract-Tutorials-E.jpg',
route: '/isc/getting-started/tools#remix',
tags: ['text', 'video'],
},
],
[
pluginTutorial,
{
title: 'Generate a WASM Smart Contract Using the Schema Tool',
description:
'In this tutorial you will learn how to use schema tool to generate smart contract template code on rust and golang',
preview: '/img/tutorials/IOTA-Smart-Contract-Tutorials-G.png',
route: '/isc/schema/how-tos/usage',
tags: ['text', 'video'],
},
],
[
pluginTutorial,
{
title:
'Generate a WASM Smart Contract Using the Schema Tool in Typescript',
description:
'In this tutorial you will learn how to use schema tool to generate smart contract template code on typescript',
preview: '/img/tutorials/IOTA-Smart-Contract-Tutorials-G.png',
route: 'https://www.youtube.com/watch?v=P5HMgmY3DMM',
tags: ['video'],
},
],
[
pluginTutorial,
{
title: 'Interact with IOTA Node Extension (INX)',
description:
'In this tutorial you will learn how to interact with the IOTA Node Extension (INX) interface based on gRPC.',
preview: '/img/tutorials/hornet-inx-interaction.png',
route: 'tutorials/hornet-inx-interaction',
tags: ['text', 'getting-started', 'shimmer', 'js'],
},
],
[
pluginTutorial,
{
title: 'Tokenless Data Notarization',
description:
'Proove that a block was part of the past Tangle, even if this part of the Tangle was already pruned from network nodes.',
preview: '/img/tutorials/proof-inclusion-of-a-block.png',
route: 'tutorials/proof-inclusion-of-a-block',
tags: ['text', 'getting-started', 'js', 'client', 'shimmer'],
},
],
[
pluginTutorial,
{
title: 'Set Up a Testnet Address and Receive Funds From the Faucet',
description:
'In this tutorial you will learn how to create a seed and address with wallet.rs and receive testnet tokens from the faucet.',
preview: '/img/tutorials/wallet-setup.png',
route: 'tutorials/wallet-setup',
tags: ['text', 'getting-started', 'node_js', 'wallet', 'shimmer'],
},
],
[
pluginTutorial,
{
title: 'How to Set Up iota.js for Development',
description:
'In this tutorial you will learn how to create a new project, generate a new address and receive x funds from the faucet.',
preview: '/img/tutorials/setup_iota-js_for_development.png',
route: 'tutorials/setup_iota-js_for_development',
tags: ['text', 'getting-started', 'client', 'shimmer', 'js'],
},
],
[
pluginTutorial,
{
title:
'Connect to Shimmer EVM Testnet and Deploy a Solidity Smart Contract',
description:
'In this tutorial, we will connect to Shimmer EVM Testnet, connect Metamask to it, get funded and deploy a smart contract in Solidity.',
preview: '/img/tutorials/connect-shimmerevm-testnet-and-deploy.png',
route: 'tutorials/shimmerevm-testnet-setup',
tags: [
'text',
'shimmer',
'solidity',
'getting-started',
'wasp',
'iscp',
'video',
],
},
],
[
pluginTutorial,
{
title:
'Tutorial - Deploy a Solidity Smart Contract on ShimmerEVM Testnet Using Hardhat',
description:
'In this tutorial, you will learn how to set up Hardhat and use it to build, test and deploy a simple smart contract on ShimmerEVM.',
preview: '/img/tutorials/shimmerevm-hardhat.jpg',
route: 'tutorials/shimmerevm-testnet-hardhat',
tags: [
'text',
'shimmer',
'solidity',
'shimmerevm',
'hardhat',
'iscp',
'video',
],
},
],
[
pluginTutorial,
{
title: 'Create a Simple Voting dApp on ShimmerEVM',
description:
'This tutorial will guide you as you write and deploy a voting dApp on ShimmerEVM. You can vote on a few options and view the results; all data will be stored on-chain.',
preview: '/img/tutorials/shimmerevm-dapp-voting.jpg',
route: 'tutorials/shimmerevm-dapp-voting',
tags: ['text', 'shimmer', 'solidity', 'iscp'],
},
],
[
pluginTutorial,
{
title: 'Set Up WASP locally Using Docker',
description:
'In this tutorial you will learn how to set up WASP and Hornet locally for Development setup.',
preview: '/img/tutorials/wasp-setup-shimmer.png',
route: 'https://youtu.be/ltem9Bh_4hA',
tags: ['text', 'shimmer', 'video', 'wasp', 'iscp'],
},
],
[
pluginTutorial,
{
title: 'Create an NFT with the IOTA SDK and IPFS in NodeJs',
description:
'In this tutorial you will learn how to create a NFT on the Shimmer network with iota-sdk and IPFS.',
preview: '/img/tutorials/create-nft-with-wallet-lib.png',
route: 'tutorials/create-nft-with-iota-sdk',
tags: [
'text',
'getting-started',
'node_js',
'iota-sdk',
'ipfs',
'shimmer',
'sdk',
],
},
],
[
pluginTutorial,
{
title: 'Send Shimmer Tokens with IOTA SDK in NodeJs',
description:
'In this tutorial you will learn how to send Shimmer Tokens with IOTA SDK in NodeJs.',
preview: '/img/tutorials/send-shimmer-tokens-with-iota-sdk.png',
route: 'tutorials/send-shimmer-tokens-with-iota-sdk',
tags: ['text', 'iota-sdk', 'sdk', 'getting-started', 'rust', 'shimmer'],
},
],
[
pluginTutorial,
{
title: 'Connect to Shimmer EVM and Deploy a Solidity Smart Contract',
description:
'In this tutorial, we will connect to Shimmer EVM, connect Metamask to it, get funded and deploy a smart contract in Solidity.',
preview: '/img/tutorials/connect-shimmerevm-and-deploy.png',
route: 'tutorials/shimmerevm-setup',
tags: [
'text',
'shimmer',
'solidity',
'getting-started',
'wasp',
'iscp',
'video',
],
},
],
[
pluginTutorial,
{
title:
'Tutorial - Deploy a Solidity Smart Contract on ShimmerEVM Using Hardhat',
description:
'In this tutorial, you will learn how to set up Hardhat and use it to build, test and deploy a simple smart contract on ShimmerEVM.',
preview: '/img/tutorials/shimmerevm-hardhat.jpg',
route: 'tutorials/shimmerevm-hardhat',
tags: [
'text',
'shimmer',
'solidity',
'shimmerevm',
'hardhat',
'iscp',
'video',
],
},
],
];
Loading

0 comments on commit f0992b7

Please sign in to comment.