Skip to content

Commit

Permalink
Merge pull request #1162 from lukso-network/chore/lukso-description-a…
Browse files Browse the repository at this point in the history
…djusted

Reorganise Quickstart section with new branding + move LUKSO wallet up on Network pages
  • Loading branch information
CJ42 authored Nov 11, 2024
2 parents 6469e94 + 8cf2280 commit f2f9d0b
Show file tree
Hide file tree
Showing 27 changed files with 680 additions and 599 deletions.
196 changes: 196 additions & 0 deletions docs/learn/benefits-lukso-standards.md

Large diffs are not rendered by default.

78 changes: 78 additions & 0 deletions docs/learn/developer-content.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
[
{
"image": "/img/learn/DEVELOPERS_dApp.png",
"imageTitle": "Dapp Developer Icon",
"cardHeading": "Dapp Developer",
"cardContent": [
{
"linkText": "Learn how to develop with Universal Profiles",
"linkPath": "../learn/universal-profile/getting-started"
},
{
"linkText": "Explore code examples in our playground repository",
"linkPath": "https://github.com/lukso-network/lukso-playground",
"newTab": true
}
]
},
{
"image": "/img/learn/DEVELOPERS_SmartContract.png",
"imageTitle": "Smart Contract Developer Icon",
"cardHeading": "Smart Contract Developer",
"cardContent": [
{
"linkText": "Get started with Tokens and NFTs",
"linkPath": "../learn/digital-assets/getting-started"
},
{
"linkText": "Create a token",
"linkPath": "../learn/digital-assets/token/create-lsp7-token"
},
{
"linkText": "Create an Automatic Token Forwarder for your UP",
"linkPath": "../learn/universal-profile/universal-receiver/create-receiver-forwarder"
}
]
},
{
"image": "",
"imageTitle": "Quickstart Integration",
"cardHeading": "Quickstart Integration",
"cardContent": [
{
"linkText": "Migrate to LUKSO",
"linkPath": "../learn/migrate/migrate-to-lukso"
},
{
"linkText": "Refactor a Solidity ERC20 token to LSP7",
"linkPath": "../learn/migrate/migrate-erc20-to-lsp7"
},
{
"linkText": "Refactor a Solidity ERC721 NFT to LSP8",
"linkPath": "../learn/migrate/migrate-erc721-to-lsp8"
}
]
},
{
"image": "",
"imageTitle": "Join the Community",
"cardHeading": "Join the Community",
"cardContent": [
{
"linkText": "Visit our support website",
"linkPath": "https://support.lukso.network/",
"newTab": true
},
{
"linkText": "Join the Developer community on Discord",
"linkPath": "https://discord.com/channels/359064931246538762/585786253992132609",
"newTab": true
},
{
"linkText": "Contact the tech team",
"linkPath": "https://support.lukso.network/contact-us",
"newTab": true
}
]
}
]
6 changes: 3 additions & 3 deletions docs/learn/digital-assets/token/create-lsp7-token.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This guide will walk you through the process of creating and deploying a custom

:::tip

You can learn about the project setup and Hardhat workflow by checking the [Getting Started](../../getting-started.mdx) section.
You can learn about the project setup and Hardhat workflow by checking the [Getting Started](../../getting-started.md) section.

:::

Expand Down Expand Up @@ -129,7 +129,7 @@ deployToken()
});
```

If you have not yet setup the LUKSO networks and private keys in Hardhat, please check out the previous [Getting Started](../../getting-started.mdx) guide for smart contract developers. If you set up the Hardhat configuration, you can execute the deployment script using the following command:
If you have not yet setup the LUKSO networks and private keys in Hardhat, please check out the previous [Getting Started](../../getting-started.md) guide for smart contract developers. If you set up the Hardhat configuration, you can execute the deployment script using the following command:

```bash
npx hardhat --network luksoTestnet run scripts/deployLSP7AsUP.ts
Expand All @@ -155,7 +155,7 @@ module.exports = [
];
```

To verify the deployed token, you can use the **blockscout API properties** set up within the [Getting Started](../../getting-started.mdx) section. If you configured the API, you will be able to run the verification by specifying the _token address_, _paramter file_, and _network_:
To verify the deployed token, you can use the **blockscout API properties** set up within the [Getting Started](../../getting-started.md) section. If you configured the API, you will be able to run the verification by specifying the _token address_, _paramter file_, and _network_:

```bash
npx hardhat verify <myTokenAddress> --constructor-args ./verify/myCustomToken.ts --network luksoTestnet
Expand Down
41 changes: 41 additions & 0 deletions docs/learn/discover-content.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
[
{
"image": "",
"imageTitle": "LSP Standards Icon",
"cardHeading": "🧱 LUKSO Standards (LSPs)",
"cardContent": [
{
"linkText": "Discover the main building blocks of LUKSO",
"linkPath": "../../standards/introduction"
},
{
"linkText": "Learn the benefits of using the LUKSO Standards",
"linkPath": "./introduction"
},
{
"linkText": "Deep dive into the specs of the LSPs",
"linkPath": "https://github.com/lukso-network/LIPs/tree/main/LSPs",
"newTab": true
}
]
},
{
"image": "",
"imageTitle": "Validator Icon",
"cardHeading": "🧬 Network & Validators",
"cardContent": [
{
"linkText": "Connect your wallet to the LUKSO Mainnet",
"linkPath": "../../networks/mainnet/parameters#add-lukso-to-wallets"
},
{
"linkText": "Run a LUKSO node",
"linkPath": "../../networks/mainnet/running-a-node"
},
{
"linkText": "Become a Validator",
"linkPath": "../../networks/mainnet/become-a-validator"
}
]
}
]
122 changes: 122 additions & 0 deletions docs/learn/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
---
sidebar_label: '🏎️ Developer Quickstart'
description: Introduction to the LUKSO Ecosystem - why choose LUKSO? Who is LUKSO intended for?
title: 'Quick Start'
---

import CallToActionButton from '@site/src/components/CallToActionButton';
import CardWithImage from '@site/src/components/CardWithImage';
import Chip from '@site/src/components/Chip';

import discoverContent from './discover-content.json';
import developerContent from './developer-content.json';

# Developer Quickstart

<CardWithImage CardData={developerContent}/>

## Building dApps with Universal Profiles

When building dApps on LUKSO, you are interacting with [Universal Profiles 🆙](../standards/accounts/introduction.md) through the [Universal Profile Browser Extension](https://chromewebstore.google.com/detail/universal-profiles/abpickdkkbnbcoepogfhkhennhfhehfn). This page guides you on the first step to get started building on LUKSO with the 🆙 Browser Extension.

<div style={{
display: 'flex',
margin: '5rem 0 5rem 0',
gap: "1rem"
}}>

<div style={{ width: '32%' }}>

<CallToActionButton
icon="material-symbols:counter-1"
color="white"
target="_blank"
link="/install-up-browser-extension"
text="Install the Universal Profile Browser Extension 🧩"
/>

</div>

<div style={{ width: '36%' }}>

<CallToActionButton
icon="material-symbols:counter-2"
color="white"
target="_blank"
link="https://my.universalprofile.cloud"
text="Create your Universal Profile 🆙 on universalprofile.cloud"
/>

</div>

<div style={{ width: '28%' }}>

<CallToActionButton
icon="material-symbols:counter-3"
color="white"
link="/learn/universal-profile/connect-profile/connect-up"
text="Start building dApps on LUKSO! 🫡"
/>

</div>

</div>

:::note Manual Deployment

You can also create new [Universal Profiles](../standards/accounts/introduction.md) by ⚒️ [deploying it programmatically](./universal-profile/advanced-guides/deploy-up-with-lsp23.md). However, please keep in mind that you would also have to deploy your own [Transaction Relay Service](../standards/accounts/lsp15-transaction-relayer-api.md) to allow gasless onboarding. Customly deployed profiles will not receive free monthly transaction quota through the LUKSO Transaction Relay Service.

:::

:::tip Relayer API

If you want to deploy Universal Profiles for your users, please check out our [Relayer API](../tools/services/relayer-developer.md).

:::

## Resources for Builders

<div class="video-container">
<iframe width="560" height="315" src="https://www.youtube.com/embed/kJ5_6LN6mZc?si=7NWn-odkk8KmSDLz" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
</div>

LUKSO is an L1 EVM-based Blockchain. All tools and tutorials for Ethereum also work for LUKSO by default.

Developers building on LUKSO can write smart contracts in any EVM-based smart contract languages (Solidity, Vyper, etc...), and use existing standards already developed for other Ethereum networks.

- [Awesome LUKSO, a comprehensive list of awesome LUKSO resources!](https://github.com/lukso-network/awesome-lukso)
- [What are the main features of LUKSO standards?](../faq/onboarding/lukso-standards.md#what-are-the-main-features-of-lsps)
- [Learning Tools of the Ethereum Foundation](https://ethereum.org/en/developers/learning-tools/)

## Code Repositories

Want to dive into the code directly? Check the following repos 😉

### Next.js Boilerplate

The [`tools-dapp-boilerplate`](https://github.com/lukso-network/tools-dapp-boilerplate) is a Next.js repository that gives you a fully working dApp with lot of ready to use components and features:

<div style={{textAlign: 'center'}}>

<img
src="https://github.com/lukso-network/tools-dapp-boilerplate/raw/main/img/front_page.png"
alt="LUKSO Boilerplate"
/>

</div>

### Playground

The [`lukso-playground`](https://github.com/lukso-network/lukso-playground) repository is a great place to start playing around with dApps. It includes:

- ready-to-go network configurations with LUKSO [Mainnet](../networks/mainnet/parameters.md) and [Testnet](../networks/testnet/parameters.md).
- a full Hardhat setup to work with smart contracts.
- example scripts to fetch profile and asset metadata, update them, and even more code examples!
- sample contracts for Tokens, NFTs and Universal Receivers to build smart contracts based on the [LSP standards](./benefits-lukso-standards.md).
- scripts to deploy and verify contracts on the network.

<div style={{textAlign: 'center'}}>

<img src="/img/guides/playground_dapp.png" alt="LUKSO Playground dApp" />

</div>
Loading

0 comments on commit f2f9d0b

Please sign in to comment.