Skip to content

Commit d2060e5

Browse files
jessiemongeon1jessiemongeon1
authored
Merge pull request #732 from dfinity/revert-back-md
fix: Revert back to .md and add links to GitHub code
2 parents dc9f023 + c13cfd5 commit d2060e5

File tree

62 files changed

+166
-227
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+166
-227
lines changed

‎hosting/godot-html5-template/README.mdx renamed to ‎hosting/godot-html5-template/README.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,9 @@
22
keywords: [html5, html, godot, hosting, host a website, beginner]
33
---
44

5-
6-
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
7-
85
# Godot HTML5 sample
96

10-
<MarkdownChipRow labels={["Beginner"]} />
7+
[View this sample's code on GitHub](https://github.com/dfinity/examples/tree/master/hosting/godot-html5-template)
118

129
## Overview
1310
The example shows how to deploy a Godot HTML5 build on the IC in an asset canister. The Godot HTML5 build is deployed as frontend, no backend is needed in this sample.

‎hosting/photo-storage/README.mdx renamed to ‎hosting/photo-storage/README.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@
22
keywords: [photo storage, store photos, photo app, photos, beginner]
33
---
44

5-
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
6-
75
# Photo storage example
86

9-
<MarkdownChipRow labels={["Beginner"]} />
7+
[View this sample's code on GitHub](https://github.com/dfinity/examples/tree/master/hosting/photo-storage)
108

119
The example shows how to store photos on ICP in an asset canister with the `@dfinity/assets` package. The photo
1210
storage app is deployed as a frontend in an asset canister which is also used for photo upload.

‎hosting/static-website/README.mdx renamed to ‎hosting/static-website/README.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@
22
keywords: [static website, basic website, html, host a website, beginner]
33
---
44

5-
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
6-
75
# Static website
86

9-
<MarkdownChipRow labels={["Beginner"]} />
7+
[View this sample's code on GitHub](https://github.com/dfinity/examples/tree/master/hosting/static-website)
108

119
## Overview
1210
The example shows how to deploy a simple, static website on the IC in an asset canister. The website is very simple, it just shows the DFINITY logo and has a basic styling of the logo.

‎hosting/unity-webgl-template/README.mdx renamed to ‎hosting/unity-webgl-template/README.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@
22
keywords: [unity, unity webgl, beginner]
33
---
44

5-
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
6-
75
# Unity WebGL sample
86

9-
<MarkdownChipRow labels={["Beginner"]} />
7+
[View this sample's code on GitHub](https://github.com/dfinity/examples/tree/master/hosting/unity-webgl-template)
108

119
The example shows how to deploy a simple Unity WebGL build on ICP in an asset canister. It just shows a Unity WebGL build with the URP template installed.
1210

‎motoko/actor_reference/README.mdx renamed to ‎motoko/actor_reference/README.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@
22
keywords: [motoko, beginner, motoko actor, actor reference]
33
---
44

5-
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
6-
75
# Actor reference
86

9-
<MarkdownChipRow labels={["Beginner", "Motoko"]} />
7+
[View this sample's code on GitHub](https://github.com/dfinity/examples/tree/master/motoko/actor_reference)
108

119
## Overview
1210

@@ -33,6 +31,7 @@ This is a Motoko example that does not currently have a Rust variant.
3331
This example requires an installation of:
3432

3533
- [x] Install the [IC SDK](https://internetcomputer.org/docs/current/developer-docs/setup/install/).
34+
- [x] Clone the example dapp project: `git clone https://github.com/dfinity/examples`
3635

3736
Begin by opening a terminal window.
3837

‎motoko/auth_client_demo/README.mdx renamed to ‎motoko/auth_client_demo/README.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@
22
keywords: [intermediate, motoko, authentication, internet identity, integrate, auth, user auth]
33
---
44

5-
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
6-
75
# Auth-client
86

9-
<MarkdownChipRow labels={["Intermediate", "Motoko"]} />
7+
[View this sample's code on GitHub](https://github.com/dfinity/examples/tree/master/motoko/auth_client_demo)
108

119
This is an example project intended to demonstrate how a developer might integrate with [Internet Identity](https://identity.ic0.app).
1210

@@ -23,7 +21,8 @@ This example shows how to use [@dfinity/auth-client](https://www.npmjs.com/packa
2321
To get started, start a local `dfx` development environment in this directory with the following steps:
2422

2523
```bash
26-
cd auth-client-demo/
24+
git clone https://github.com/dfinity/examples
25+
cd examples/motoko/auth-client-demo/
2726
dfx start --background --clean
2827
dfx deps deploy
2928
dfx deploy

‎motoko/basic_bitcoin/README.mdx renamed to ‎motoko/basic_bitcoin/README.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@
22
keywords: [advanced, motoko, bitcoin, bitcoin integration, btc]
33
---
44

5-
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
6-
75
# Basic Bitcoin
86

9-
<MarkdownChipRow labels={["Advanced", "Motoko"]} />
7+
[View this sample's code on GitHub](https://github.com/dfinity/examples/tree/master/motoko/basic_bitcoin)
108

119
## Overview
1210
This tutorial will walk you through how to deploy a sample [canister smart contract](https://wiki.internetcomputer.org/wiki/Canister_smart_contract) **that can send and receive Bitcoin** on the Internet Computer.

‎motoko/basic_dao/README.mdx renamed to ‎motoko/basic_dao/README.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,9 @@
22
keywords: [advanced, motoko, dao, decentralized organization, decentralized org]
33
---
44

5-
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
6-
75
# Basic DAO
86

9-
<MarkdownChipRow labels={["Advanced", "Motoko"]} />
10-
7+
[View this sample's code on GitHub](https://github.com/dfinity/examples/tree/master/motoko/basic_dao)
118

129
This sample project demonstrates a basic [decentralized autonomous organization](https://en.wikipedia.org/wiki/Decentralized_autonomous_organization) (DAO) that can be deployed to the [Internet Computer](https://github.com/dfinity/ic). The basic DAO sample code is available in [Motoko](https://github.com/dfinity/examples/tree/master/motoko/basic_dao) and [Rust](https://github.com/dfinity/examples/tree/master/rust/basic_dao). You can see a quick introduction on [YouTube](https://youtu.be/3IcYlieA-EE).
1310

@@ -27,13 +24,14 @@ This example requires an installation of:
2724

2825
- [x] Install the [IC SDK](https://internetcomputer.org/docs/current/developer-docs/setup/install/).
2926
- [x] To run the test scripts, you need to download [ic-repl](https://github.com/chenyan2002/ic-repl/releases).
27+
- [x] Clone the example dapp project: `git clone https://github.com/dfinity/examples`
3028

3129
Begin by opening a terminal window.
3230

3331
### Step 1: Navigate into the folder containing the project's files and start a local instance of the Internet Computer with the command:
3432

3533
```bash
36-
cd basic_dao
34+
cd examples/motoko/basic_dao
3735
dfx start --background
3836
```
3937

‎motoko/calc/README.mdx renamed to ‎motoko/calc/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,10 @@
22
keywords: [basic, motoko, calculator, calc]
33
---
44

5-
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
6-
75
# Calculator
86

9-
<MarkdownChipRow labels={["Beginner", "Motoko"]} />
7+
[View this sample's code on GitHub](https://github.com/dfinity/examples/tree/master/motoko/calc)
8+
109

1110
## Overview
1211

@@ -27,6 +26,7 @@ This is a Motoko example that does not currently have a Rust variant.
2726
This example requires an installation of:
2827

2928
- [x] Install the [IC SDK](https://internetcomputer.org/docs/current/developer-docs/setup/install/index.mdx).
29+
- [x] Clone the example dapp project: `git clone https://github.com/dfinity/examples`
3030

3131
Begin by opening a terminal window.
3232

‎motoko/cert-var/README.mdx renamed to ‎motoko/cert-var/README.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@
22
keywords: [intermediate, motoko, cert var, certified variables]
33
---
44

5-
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
6-
75
# Certified variables
86

9-
<MarkdownChipRow labels={["Intermediate", "Motoko"]} />
7+
[View this sample's code on GitHub](https://github.com/dfinity/examples/tree/master/motoko/cert-var)
108

119
## Overview
1210
This example demonstrates the use of a single cryptographically certified variable, as supported by the Internet Computer.
@@ -53,6 +51,7 @@ This example requires an installation of:
5351

5452
- [x] Install the [IC SDK](https://internetcomputer.org/docs/current/developer-docs/setup/install/index.mdx).
5553
- [x] Download [npm](https://nodejs.org/en/download/).
54+
- [x] Clone the example dapp project: `git clone https://github.com/dfinity/examples`
5655

5756
Begin by opening a terminal window.
5857

‎motoko/classes/README.mdx renamed to ‎motoko/classes/README.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@
22
keywords: [beginner, motoko, classes, actor classes]
33
---
44

5-
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
6-
75
# Classes
86

9-
<MarkdownChipRow labels={["Beginner", "Motoko"]} />
7+
[View this sample's code on GitHub](https://github.com/dfinity/examples/tree/master/motoko/classes)
108

119
## Overview
1210

@@ -33,6 +31,7 @@ This is a Motoko example that does not currently have a Rust variant.
3331
This example requires an installation of:
3432

3533
- [x] Install the [IC SDK](https://internetcomputer.org/docs/current/developer-docs/setup/install/).
34+
- [x] Clone the example dapp project: `git clone https://github.com/dfinity/examples`
3635

3736
Begin by opening a terminal window.
3837

‎motoko/composite_query/README.mdx renamed to ‎motoko/composite_query/README.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@
22
keywords: [beginner, motoko, composite queries, queries]
33
---
44

5-
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
6-
75
# Composite queries
86

9-
<MarkdownChipRow labels={["Beginner", "Motoko"]} />
7+
[View this sample's code on GitHub](https://github.com/dfinity/examples/tree/master/motoko/composite_query)
108

119
## Overview
1210

@@ -41,9 +39,11 @@ Each new `Bucket` must be provisioned with enough cycles to pay for its installa
4139

4240
Verify the following before running this demo:
4341

44-
* You have downloaded and installed [dfx](https://sdk.dfinity.org).
42+
- [x] You have downloaded and installed [dfx](https://sdk.dfinity.org).
43+
44+
- [x] You have stopped any process that would create a port conflict on `8000`.
4545

46-
* You have stopped any process that would create a port conflict on `8000`.
46+
- [x] Clone the example dapp project: `git clone https://github.com/dfinity/examples`
4747

4848
## Install
4949

@@ -58,6 +58,7 @@ dfx start
5858
### Step 3: Deploy the `Map` canister:
5959

6060
```bash
61+
cd examples/motoko/composite_query
6162
dfx deploy
6263
```
6364

‎motoko/counter/README.mdx renamed to ‎motoko/counter/README.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@
22
keywords: [beginner, motoko, counter, count]
33
---
44

5-
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
6-
75
# Counter
86

9-
<MarkdownChipRow labels={["Beginner", "Motoko"]} />
7+
[View this sample's code on GitHub](https://github.com/dfinity/examples/tree/master/motoko/counter)
108

119
## Overview
1210

@@ -24,6 +22,7 @@ The application provides an interface that exposes the following methods:
2422
This example requires an installation of:
2523

2624
- [x] Install the [IC SDK](https://internetcomputer.org/docs/current/developer-docs/setup/install/index.mdx).
25+
- [x] Clone the example dapp project: `git clone https://github.com/dfinity/examples`
2726

2827
Begin by opening a terminal window.
2928

‎motoko/defi/README.mdx renamed to ‎motoko/defi/README.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@
22
keywords: [advanced, motoko, defi, decentralized exchange, dex, exchange]
33
---
44

5-
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
6-
75
# Decentralized exchange sample
86

9-
<MarkdownChipRow labels={["Advanced", "Motoko"]} />
7+
[View this sample's code on GitHub](https://github.com/dfinity/examples/tree/master/motoko/defi)
108

119
## Overview
1210

@@ -98,7 +96,6 @@ Compared to depositing funds, withdrawing funds is simpler. Since the exchange h
9896

9997
```bash
10098
git clone --recurse-submodules --shallow-submodules https://github.com/dfinity/examples.git
101-
# for the rust implementation examples/rust/defi
10299
cd examples/motoko/defi
103100
make install
104101
```

‎motoko/dip721-nft-container/README.mdx renamed to ‎motoko/dip721-nft-container/README.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@
22
keywords: [advanced, motoko, nfts, dip721]
33
---
44

5-
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
6-
75
# DIP721 NFTs
86

9-
<MarkdownChipRow labels={["Advanced", "Motoko"]} />
7+
[View this sample's code on GitHub](https://github.com/dfinity/examples/tree/master/motoko/dip721-nft-container)
108

119
This example demonstrates implementing an NFT canister. NFTs (non-fungible tokens) are unique tokens with arbitrary
1210
metadata, usually an image of some kind, to form the digital equivalent of trading cards. There are a few different

‎motoko/echo/README.mdx renamed to ‎motoko/echo/README.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@
22
keywords: [beginner, motoko, echo]
33
---
44

5-
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
6-
75
# Echo
86

9-
<MarkdownChipRow labels={["Beginner", "Motoko"]} />
7+
[View this sample's code on GitHub](https://github.com/dfinity/examples/tree/master/motoko/echo)
108

119
## Overview
1210

@@ -19,6 +17,7 @@ This is a Motoko example that does not currently have a Rust variant.
1917
This example requires an installation of:
2018

2119
- [x] Install the [IC SDK](https://internetcomputer.org/docs/current/developer-docs/setup/install/).
20+
- [ ] Clone the example dapp project: `git clone https://github.com/dfinity/examples`
2221

2322
Begin by opening a terminal window.
2423

‎motoko/encrypted-notes-dapp-vetkd/README.mdx renamed to ‎motoko/encrypted-notes-dapp-vetkd/README.md

+10-5
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@
22
keywords: [advanced, motoko, encrypted, encrypted notes, notes dapp, vetkeys, vetkd]
33
---
44

5-
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
6-
75
# Encrypted notes: vetKD
86

9-
<MarkdownChipRow labels={["Advanced", "Motoko"]} />
7+
[View this sample's code on GitHub](https://github.com/dfinity/examples/tree/master/motoko/encrypted-notes-dapp-vetkd)
108

119
This is a copy of the `encrypted-notes-dapp` example, adapted to use [the proposed vetKD feature](https://github.com/dfinity/interface-spec/pull/158) and add sharing of notes between users.
1210

@@ -16,16 +14,22 @@ The vetKey used to encrypt and decrypt a note is note-ID-specific (and not, for
1614

1715
Currently, the only way to use this dapp is via manual local deployment (see below).
1816

19-
Please also see the [README of the original encrypted-notes-dapp](../encrypted-notes-dapp/README.mdx) for further details.
17+
Please also see the [README of the original encrypted-notes-dapp](../encrypted-notes-dapp/README.md) for further details.
2018

2119
## Disclaimer
2220

2321
This example uses an **insecure** implementation of [the proposed vetKD system API](https://github.com/dfinity/interface-spec/pull/158) in a pre-compiled form via the [vetkd_system_api.wasm](./vetkd_system_api.wasm). **Do not use this in production or for sensitive data**! This example is solely provided **for demonstration purposes** to collect feedback on the mentioned vetKD system API.
2422

2523
## Manual local deployment
24+
25+
### Prerequisites
26+
27+
- [x] Clone the example dapp project: `git clone https://github.com/dfinity/examples`
28+
2629
### Step 1: Choose which implementation to use by setting a respective environment variable.
2730

28-
For **Motoko** deployment use
31+
For **Motoko** deployment use:
32+
2933
```sh
3034
export BUILD_ENV=motoko
3135
```
@@ -70,6 +74,7 @@ If you have multiple `dfx` identities set up, ensure you are using the identity
7074
:::
7175
1. To install and deploy a canister run:
7276
```sh
77+
cd examples/motoko/encrypted-notes-dapp-vetkd
7378
dfx deploy internet_identity --argument '(null)'
7479
```
7580
2. To print the Internet Identity URL, run:

0 commit comments

Comments
 (0)