Skip to content

Commit

Permalink
feat:update view
Browse files Browse the repository at this point in the history
  • Loading branch information
karlavasquez8 committed May 8, 2024
1 parent 165292d commit a23bf5e
Show file tree
Hide file tree
Showing 10 changed files with 102 additions and 40 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
node_modules
.docusaurus
build
build
.idea
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ To run the Documentation site locally, but first ensure you have [Node](https://
Clone the repository, install all dependencies as well as build all local packages, and then start Docusaurus.

```
git clone https://github.com/scaffold-eth/se2-docs.git
cd se2-docs
git clone https://github.com/Quantum3-Labs/ss2-docs.git
cd ss2-docs
npm install
npm run start
```
Expand Down
4 changes: 2 additions & 2 deletions docs/contributing/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
sidebar_position: 7
---

# 🙏 Contributing to Scaffold-ETH 2
# 🙏 Contributing to Scaffold-Stark 2

We welcome contributions to Scaffold-ETH 2!
We welcome contributions to Scaffold-Stark 2!

This section aims to provide an overview of the contribution workflow to help us make the contribution process effective for everyone involved.

Expand Down
4 changes: 2 additions & 2 deletions docs/hooks/hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ sidebar_position: 4

# 🛠 Interacting with Your Smart Contracts

Scaffold-ETH 2 provides a collection of custom React hooks designed to simplify interactions with your deployed smart contracts. These hooks are wrappers around Wagmi, an easy-to-use interface with typescript autocompletions for reading from, writing to, and monitoring events emitted by your smart contracts.
Scaffold-Stark 2 provides a collection of custom React hooks designed to simplify interactions with your deployed smart contracts. These hooks are wrappers around Wagmi, an easy-to-use interface with typescript autocompletions for reading from, writing to, and monitoring events emitted by your smart contracts.

If you need to interact with external contracts (i.e. not deployed with your SE-2 instance) you can add external contract data to your `packages/nextjs/contracts/externalContracts.ts` file, which would let you use Scaffold-ETH 2 hooks.
If you need to interact with external contracts (i.e. not deployed with your SS-2 instance) you can add external contract data to your `packages/nextjs/contracts/externalContracts.ts` file, which would let you use Scaffold-ETH 2 hooks.

To achieve this, include the contract name, its `address`, and `abi` in `externalContracts.ts` for each chain ID. Ensure to update the [`targetNetworks`](/deploying/deploy-nextjs-app#--targetnetworks) in `scaffold.config.ts` to your preferred chains to enable hooks typescript autocompletion.

Expand Down
20 changes: 10 additions & 10 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,29 +3,29 @@ sidebar_position: 1
slug: /
---

# 🏗 Welcome to Scaffold-ETH 2
# 🏗 Welcome to Scaffold-Stark 2

[Scaffold-ETH](https://github.com/scaffold-eth/scaffold-eth-2) is everything you need to get started building decentralized applications on Ethereum! 🚀
[Scaffold-Stark](https://github.com/Quantum3-Labs/scaffold-stark-2) is everything you need to get started building decentralized applications on Starknet! 🚀

⚙️ Built using NextJS, RainbowKit, Hardhat, Foundry, Wagmi, and TypeScript.
⚙️ Built using NextJS, StarknetJS, Scarb, Starknet-React, Cairo and Typescript.

## About Scaffold-ETH 2
## About Scaffold-Stark 2

Scaffold-ETH is an open-source, up-to-date toolkit for building decentralized applications (dapps) on the Ethereum blockchain. It's designed to make it easier for developers to create and deploy smart contracts and build user interfaces that interact with those contracts.
Scaffold-Stark is an open-source, up-to-date toolkit for building decentralized applications (dapps) on the Starknet blockchain. It's designed to make it easier for developers to create and deploy smart contracts and build user interfaces that interact with those contracts.

-**Contract Hot Reload**: Your frontend auto-adapts to your smart contract as you edit it.
- 🔥 **Burner Wallet & Local Faucet**: Quickly test your application with a burner wallet and local faucet.
- 🔐 **Integration with Wallet Providers**: Connect to different wallet providers and interact with the Ethereum network.
- 🔐 **Integration with Wallet Providers**: Connect to different wallet providers and interact with the Starknet network.

## Scaffold-ETH 2 Tech Stack
## Scaffold-Stark2 Tech Stack

Scaffold-ETH is not a product itself but more of a combination or stack of other great tools. It allows you to quickly build and iterate over your smart contracts and frontends.
Scaffold-Stark is not a product itself but more of a combination or stack of other great tools. It allows you to quickly build and iterate over your smart contracts and frontends.

Here are the main components:

- [**Hardhat**](https://hardhat.org/docs) or [**Foundry**](https://book.getfoundry.sh/) (user's choice) for running local networks, deploying and testing smart contracts.
- [**Wagmi**](https://wagmi.sh/react/getting-started) for React Hooks to start working with Ethereum.
- [**Viem**](https://viem.sh/docs/getting-started.html) as low-level interface that provides primitives to interact with Ethereum. The alternative to ethers.js and web3.js.
- [**Wagmi**](https://wagmi.sh/react/getting-started) for React Hooks to start working with Starknet.
- [**Viem**](https://viem.sh/docs/getting-started.html) as low-level interface that provides primitives to interact with Starknet. The alternative to ethers.js and web3.js.
- [**NextJS**](https://nextjs.org/docs) for building a frontend, using many useful pre-made hooks.
- [**RainbowKit**](https://www.rainbowkit.com/docs/) for adding wallet connection.
- [**DaisyUI**](https://daisyui.com/docs/) for pre-built [Tailwind CSS](https://tailwindui.com/components) components.
6 changes: 3 additions & 3 deletions docs/quick-start/environment.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
sidebar_position: 2
description: How to set up your development environment for Scaffold ETH-2.
description: How to set up your development environment for Scaffold Stark-2.
---

# Environment

Now that our installation is complete, let's configure the development environment for Scaffold ETH-2.
Now that our installation is complete, let's configure the development environment for Scaffold Stark-2.

### 1. **Initialize a Local Blockchain**:

Expand All @@ -15,7 +15,7 @@ In the first terminal, run a local network:
yarn chain
```

This command starts a local Ethereum network using Hardhat or Foundry, depending on which one you selected in the CLI. The network runs on your local machine and can be used for testing and development. You can customize the network configuration in:
This command starts a local Starknet network using Hardhat or Foundry, depending on which one you selected in the CLI. The network runs on your local machine and can be used for testing and development. You can customize the network configuration in:

- Hardhat => `packages/hardhat/hardhat.config.ts`
- Foundry => `packages/foundry/foundry.toml`
Expand Down
6 changes: 3 additions & 3 deletions docs/quick-start/installation.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_position: 1
description: Requirements and installation methods to get started with Scaffold ETH-2.
description: Requirements and installation methods to get started with Scaffold Stark-2.
---

# Installation
Expand All @@ -25,8 +25,8 @@ To get started with Scaffold-ETH 2, you have two options:
Clone this repo & install dependencies:

```
git clone https://github.com/scaffold-eth/scaffold-eth-2.git
cd scaffold-eth-2
git clone https://github.com/Quantum3-Labs/scaffold-stark-2
cd scaffold-stark-2
yarn install
```

Expand Down
34 changes: 17 additions & 17 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ const darkCodeTheme = require("prism-react-renderer/themes/dracula");

/** @type {import('@docusaurus/types').Config} */
const config = {
title: "🏗 Scaffold-ETH 2 | Docs",
title: "🏗 Scaffold-Stark 2 | Docs",
tagline: "Open-source toolkit for building dapps",
favicon: "img/favicon.png",
favicon: "img/icon-starknet.svg",

// Set the production url of your site here
url: "https://scaffold-eth-2-docs.vercel.app",
Expand All @@ -18,15 +18,15 @@ const config = {

// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: "scaffold-eth",
projectName: "scaffold-eth-2",
organizationName: "scaffold-stark",
projectName: "scaffold-Stark-2",

scripts: [
{
src: "https://plausible.io/js/plausible.js",
async: true,
defer: true,
"data-domain": "docs.scaffoldeth.io",
"data-domain": "docs.scaffoldstark.io",
},
],

Expand All @@ -52,7 +52,7 @@ const config = {
// sidebarCollapsible: false,
sidebarCollapsed: true,
// Remove this to remove the "edit this page" links.
editUrl: "https://github.com/scaffold-eth/se2-docs/edit/main/",
editUrl: "https://github.com/Quantum3-Labs/ss2-docs/edit/main/",
},
blog: false,
theme: {
Expand All @@ -71,10 +71,10 @@ const config = {
},
image: "img/thumbnail.jpg",
navbar: {
title: "Scaffold-ETH 2 | Docs",
title: "Scaffold-Stark 2 | Docs",
logo: {
alt: "scaffold-eth-logo",
src: "img/logo.svg",
alt: "scaffold-stark-logo",
src: "img/logo-starknet.svg",
},
items: [
// commented until Scaffold-eth 2 website is launched
Expand All @@ -84,13 +84,13 @@ const config = {
// position: 'left',
// },
{
href: "https://github.com/scaffold-eth/se2-docs",
href: "https://github.com/Quantum3-Labs/ss2-docs",
label: "GitHub Docs",
position: "right",
},
{
href: "https://github.com/scaffold-eth/scaffold-eth-2",
label: "GitHub SE-2",
href: "https://github.com/Quantum3-Labs/scaffold-stark-2",
label: "GitHub SS-2",
position: "right",
},
],
Expand All @@ -115,12 +115,12 @@ const config = {
title: "GitHub",
items: [
{
label: "Scaffold-Eth 2 GitHub",
href: "https://github.com/scaffold-eth/scaffold-eth-2",
label: "Scaffold-Stark 2 GitHub",
href: "https://github.com/Quantum3-Labs/scaffold-stark-2",
},
{
label: "Docs GitHub",
href: "https://github.com/scaffold-eth/se2-docs",
href: "https://github.com/Quantum3-Labs/ss2-docs",
},
],
},
Expand All @@ -129,7 +129,7 @@ const config = {
items: [
{
label: "Twitter",
href: "https://twitter.com/ScaffoldETH",
href: "https://twitter.com/ScaffoldSTARK",
},
{
label: "Telegram",
Expand All @@ -142,7 +142,7 @@ const config = {
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Scaffold-eth Docs. Built with Docusaurus.`,
copyright: `Copyright © ${new Date().getFullYear()} Scaffold-stark Docs. Built with Docusaurus.`,
},
prism: {
theme: lightCodeTheme,
Expand Down
27 changes: 27 additions & 0 deletions static/img/icon-starknet.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit a23bf5e

Please sign in to comment.