Skip to content

Commit 6748294

Browse files
Merge pull request #1176 from dfinity/jessiemongeon1-patch-7
standardize README
2 parents 126113f + d54d14d commit 6748294

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

motoko/filevault/README.md

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

33
FileVault is a file storage application that allows you to upload files from your local computer and store them onchain. FileVault uses Internet Identity (II) for user login and authentication. Once files are uploaded, they can be downloaded at a later time, or they can be deleted.
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

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/motoko/filevault)
1210

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

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

17-
## Build and deploy from the command-line
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/)
16+
17+
### 3. Navigate into the project's directory.
18+
19+
### 4. Deploy the project to your local environment:
1820

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.
21+
```
22+
dfx start --background --clean && dfx deploy
23+
```
2024

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

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

0 commit comments

Comments
 (0)