Skip to content

Commit e4096f2

Browse files
Merge pull request #1174 from dfinity/jessiemongeon1-patch-5
standardize README
2 parents 6748294 + 550804c commit e4096f2

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

motoko/daily_planner/README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,24 @@
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 [Motoko](https://internetcomputer.org/docs/motoko/main/getting-started/motoko-introduction), a programming language designed specifically for developing canisters on ICP.
6-
75
## Deploying from ICP Ninja
86

9-
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:
7+
[![](https://icp.ninja/assets/open.svg)](https://icp.ninja/editor?g=https://github.com/dfinity/examples/tree/master/motoko/daily_planner)
8+
9+
## Build and deploy from the command-line
1010

11-
[![](https://icp.ninja/assets/open.svg)](https://icp.ninja/i?g=https://github.com/dfinity/examples/motoko/daily_planner)
11+
### 1. [Download and install the IC SDK.](https://internetcomputer.org/docs/building-apps/getting-started/install)
1212

13-
## Project structure
13+
### 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/)
1414

15-
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.
15+
### 3. Navigate into the project's directory.
1616

17-
## Build and deploy from the command-line
17+
### 4. Deploy the project to your local environment:
1818

19-
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+
```
20+
dfx start --background --clean && dfx deploy
21+
```
2022

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

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