-
Notifications
You must be signed in to change notification settings - Fork 54
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
896ce28
commit 86f24b7
Showing
12 changed files
with
82 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,25 @@ | ||
# Summary | ||
|
||
- [Chapter 1](./chapter_1.md) | ||
- [Chapter 2](./chapter_2.md) | ||
- [Introduction](./chapter_1.md) | ||
- [Quickstart](./chapter_2.md) | ||
- [Installation](./chapter_2/subchapter_1.md) | ||
- [Environment](./chapter_2/subchapter_2.md) | ||
- [Chapter 3](./chapter_3.md) | ||
- [Tool version](./chapter_2/subchapter_3.md) | ||
- [UI Components](./chapter_3.md) | ||
- [Connect button & Custom Wallet Modal](./chapter_3/subchapter_1.md) | ||
- [Address bar (Displays StarknetID)](./chapter_3/subchapter_2.md) | ||
- [Transactions List](./chapter_3/subchapter_3.md) | ||
- [User modal](./chapter_3/subchapter_4.md) | ||
- [Display account balance](./chapter_3/subchapter_5.md) | ||
- [Switch/display network](./chapter_3/subchapter_6.md) | ||
- [App Light/Dark mode](./chapter_3/subchapter_7.md) | ||
- [Chapter 4](./chapter_4.md) | ||
- [Tour Guide](./chapter_4.md) | ||
- [Deployer](./chapter_4/subchapter_1.md) | ||
- [Burner](./chapter_4/subchapter_2.md) | ||
- [Faucet](./chapter_4/subchapter_3.md) | ||
- [Wikipedia](./chapter_4/subchapter_4.md) | ||
- [Converter](./chapter_4/subchapter_5.md) | ||
- [Address Book](./chapter_4/subchapter_6.md) | ||
- [Chapter 5](./chapter_5.md) | ||
- [Chapter 6](./chapter_6.md) | ||
- [Chapter 7](./chapter_7.md) | ||
- [Chapter 8](./chapter_8.md) | ||
- [Scripts Overview](./chapter_5.md) | ||
- [Devnet](./chapter_6.md) | ||
- [Address Book](./chapter_7.md) | ||
- [Contributing Guide](./chapter_8.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,8 +9,6 @@ Before you begin, ensure you have the following tools installed on your system: | |
* [Node (v18 LTS)](https://nodejs.org/en/download/package-manager) | ||
* [Rust](https://www.rust-lang.org/tools/install) | ||
* [Git](https://git-scm.com/downloads) | ||
* [Scarb](https://docs.swmansion.com/scarb/download.html) | ||
* [Starknet Foundry](https://foundry-rs.github.io/starknet-foundry/getting-started/installation.html) | ||
* [Docker](https://docs.docker.com/get-docker/) | ||
|
||
## Installation Methods | ||
|
@@ -24,26 +22,25 @@ The recommended way to get started with Starknet-Scaffold is by using the `creat | |
|
||
1. Run the executable | ||
|
||
Open your terminal and run one of the following commands depending on your desired setup: | ||
|
||
* For a project that needs to utilize our full debugging suite: | ||
``` | ||
npx create-starknet-app my-app debugger | ||
``` | ||
Open your terminal and run: | ||
``` | ||
npx create-starknet-app | ||
``` | ||
You'll be prompted for a project name, and a package type, enter both to proceed. | ||
|
||
Available package types include: | ||
* **contract-only:** For a project that require just contract-related tools (no frontend). | ||
|
||
* For a project that only needs customizable out-of-the-box UI components: | ||
``` | ||
npx create-starknet-app my-app basic | ||
``` | ||
* **fullstack:** For full stack projects. Provides customizable [out-of-the-box UI](../chapter_3.md) components. | ||
|
||
* If you don't specify a type, it defaults to the debugger mode: | ||
``` | ||
npx create-starknet-app my-app | ||
``` | ||
* **dojo:** For gaming projects which needs access to the dojo stack. | ||
|
||
Replace `my-app` with your project name. | ||
* **debugger:** For projects with need to utilize the full debugging suite. | ||
|
||
After running the command, follow the prompts to customize your new Starknet application. | ||
Once installation is completed, navigate to the project directory: | ||
``` | ||
cd my-project | ||
``` | ||
|
||
### Method Two: Cloning the repository from GitHub. | ||
|
||
|
@@ -54,7 +51,7 @@ To get started with Starknet-Scaffold via GitHub, follow these steps: | |
Clone the Starknet-Scaffold repository from GitHub to your local machine. Open your terminal or command prompt and run the following command: | ||
|
||
``` | ||
git clone git@github.com:argentlabs/Starknet-Scaffold.git | ||
[email protected]:horuslabsio/Starknet-Scaffold.git | ||
``` | ||
|
||
2. Navigate to the Project Directory | ||
|
@@ -63,4 +60,6 @@ To get started with Starknet-Scaffold via GitHub, follow these steps: | |
|
||
``` | ||
cd Starknet-Scaffold | ||
``` | ||
``` | ||
|
||
**PS: The executable automatically installs Scarb and Starknet Foundry, if you do not have them installed locally.** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# Tool version | ||
|
||
## Starknet Scaffold v0.5.0 | ||
- Cairo: v2.7.0 | ||
- Scarb: v2.7.0 | ||
- Starknet Foundry: v0.27.0 | ||
- starknet-react/chains: v0.1.7 | ||
- starknet-react/core: v2.9.0 | ||
- Starknet.js: v6.11.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# App Light/Dark mode |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters