Skip to content

Commit 021d932

Browse files
Merge pull request #1192 from dfinity/jessiemongeon1-patch-22
standardize README
2 parents 3d2b3ef + 73de417 commit 021d932

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

rust/backend_only/README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,28 @@
1-
# Rust Backend
1+
# Rust backend
22

33
This backend only project demonstrates how to write a simple smart contract for ICP.
44

5-
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.
6-
75
## Deploying from ICP Ninja
86

97
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:
108

119
[![](https://icp.ninja/assets/open.svg)](https://icp.ninja/i?g=https://github.com/dfinity/examples/rust/backend_only)
1210

13-
## Project structure
11+
## Build and deploy from the command-line
1412

15-
The `/backend` folder contains the Rust smart contract:
13+
### 1. [Download and install the IC SDK.](https://internetcomputer.org/docs/building-apps/getting-started/install)
1614

17-
- `Cargo.toml`, which defines the crate that will form the backend
18-
- `lib.rs`, which contains the actual smart contract, and exports its interface
15+
### 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/)
1916

20-
## Build and deploy from the command-line
17+
### 3. Navigate into the project's directory.
18+
19+
### 4. Deploy the project to your local environment:
20+
21+
```
22+
dfx start --background --clean && dfx deploy
23+
```
2124

22-
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.
25+
## Security considerations and best practices
2326

24-
### 1. Download your project from ICP Ninja using the 'Download files' button on the upper left corner under the pink ninja star icon.
27+
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.
2528

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

0 commit comments

Comments
 (0)