Skip to content

Commit 407dec9

Browse files
Merge pull request #1215 from dfinity/jessiemongeon1-patch-46
Standardize README
2 parents 61059a3 + 2ce48a5 commit 407dec9

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

rust/tokenmania/README.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,27 @@ Tokenmania is a simplified token minting application. When the application is ra
66
> This sample application is not production-ready code. Actual tokens deployed on ICP will require a ledger and an index smart contract. For this example's demonstration, this functionality has been simplified and the ledger functionality has been included in the backend. Tokens deployed using this example are only available for 20 minutes and will be deleted afterwards. They should be treated as "testnet" assets and should not be given real value.
77
> For more information on creating tokens using a recommended production workflow, view the [create a token documentation](https://internetcomputer.org/docs/current/developer-docs/defi/tokens/create).
88
9-
This application's logic is written in [Rust](https://internetcomputer.org/docs/building-apps/developer-tools/cdks/rust/intro-to-rust), a primary programming language for developing canisters on ICP.
10-
119
## Deploying from ICP Ninja
1210

1311
When viewing this project in ICP Ninja, you can deploy it directly to the mainnet for free by clicking "Deploy" in the upper right corner. Open this project in ICP Ninja:
1412

1513
[![](https://icp.ninja/assets/open.svg)](https://icp.ninja/i?g=https://github.com/dfinity/examples/rust/tokenmania)
1614

17-
## Project structure
15+
## Build and deploy from the command-line
16+
17+
### 1. [Download and install the IC SDK.](https://internetcomputer.org/docs/building-apps/getting-started/install)
1818

19-
The `/backend` folder contains the Rust smart contract:
19+
### 2. Download your project from ICP Ninja using the 'Download files' button on the upper left corner, or [clone the GitHub examples repository.](https://github.com/dfinity/examples/)
2020

21-
- `Cargo.toml`, which defines the crate that will form the backend
22-
- `lib.rs`, which contains the core logic of the smart contract, and exports its interface
23-
- `types.rs`, which contains type declarations and some conversion functions to keep the main logic cleaner.
21+
### 3. Navigate into the project's directory.
2422

25-
The `/frontend` folder contains web assets for the application's user interface. The user interface is written using the React framework.
23+
### 4. Deploy the project to your local environment:
2624

27-
## Build and deploy from the command-line
25+
```
26+
dfx start --background --clean && dfx deploy
27+
```
2828

29-
To migrate your ICP Ninja project off of the web browser and develop it locally, follow these steps. These steps are necessary if you want to deploy this project for long-term, production use on the mainnet.
29+
## Security considerations and best practices
3030

31-
### 1. Download your project from ICP Ninja using the 'Download files' button on the upper left corner under the pink ninja star icon.
31+
If you base your application on this example, it is recommended that you familiarize yourself with and adhere to the [security best practices](https://internetcomputer.org/docs/building-apps/security/overview) for developing on ICP. This example may not implement all the best practices.
3232

33-
### 2. Open the `BUILD.md` file for further instructions.

0 commit comments

Comments
 (0)