Skip to content

Commit a4e57a2

Browse files
Update README.md
1 parent 237c6cf commit a4e57a2

File tree

1 file changed

+7
-12
lines changed

1 file changed

+7
-12
lines changed

rust/daily_planner/README.md

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,22 @@
22

33
Daily planner features a monthly calender that can be used to track daily activities, appointments, or tasks. Data for each task is stored onchain. For each day, a historic fact can be queried using HTTPS outcalls, which is a feature that allows ICP canisters to obtain data from external sources.
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/daily_planner)
1210

13-
## Project structure
14-
15-
The `/backend` folder contains the Rust smart contract:
11+
## Build and deploy from the command-line
1612

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
13+
### 1. [Download and install the IC SDK.](https://internetcomputer.org/docs/building-apps/getting-started/install)
1914

20-
The `/frontend` folder contains web assets for the application's user interface. The user interface is written using the React framework.
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/)
2116

22-
## Build and deploy from the command-line
17+
### 3. Navigate into the project's directory.
2318

24-
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.
19+
### 4. Run `dfx start --background --clean && dfx deploy` to deploy the project to your local environment.
2520

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

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