Skip to content

Commit e2fd677

Browse files
Merge pull request #1190 from dfinity/jessiemongeon1-patch-20
Standardize README
2 parents cf1bada + 2411fd7 commit e2fd677

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

motoko/tokenmania/README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,26 @@ Tokenmania is a simplified token minting application. When the application is ra
88
> 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.
99
> 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).
1010
11-
This application's logic is written in [Motoko](https://internetcomputer.org/docs/motoko/main/getting-started/motoko-introduction), a programming language designed specifically for developing canisters on ICP.
12-
1311
## Deploying from ICP Ninja
1412

1513
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:
1614

1715
[![](https://icp.ninja/assets/open.svg)](https://icp.ninja/i?g=https://github.com/dfinity/examples/motoko/tokenmania)
1816

19-
## Project structure
17+
## Build and deploy from the command-line
2018

21-
The `/backend` folder contains the Motoko canister, `app.mo`. The `/frontend` folder contains web assets for the application's user interface. The user interface is written using the React framework. Edit the `mops.toml` file to add [Motoko dependencies](https://mops.one/) to the project.
19+
### 1. [Download and install the IC SDK.](https://internetcomputer.org/docs/building-apps/getting-started/install)
2220

23-
## Build and deploy from the command-line
21+
### 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/)
22+
23+
### 3. Navigate into the project's directory.
24+
25+
### 4. Deploy the project to your local environment:
2426

25-
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.
27+
```
28+
dfx start --background --clean && dfx deploy
29+
```
2630

27-
### 1. Download your project from ICP Ninja using the 'Download files' button on the upper left corner under the pink ninja star icon.
31+
## Security considerations and best practices
2832

29-
### 2. Open the `BUILD.md` file for further instructions.
33+
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.

0 commit comments

Comments
 (0)