Skip to content

Commit c2d0b37

Browse files
viviveeveeviviveevee
committed
add motoko/backend_only
1 parent ddd6681 commit c2d0b37

File tree

8 files changed

+248
-0
lines changed

8 files changed

+248
-0
lines changed

‎.github/workflows/motoko-backend-only-example.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: motoko-backend-only
2+
on:
3+
push:
4+
branches:
5+
- master
6+
pull_request:
7+
paths:
8+
- motoko/backend_only/**
9+
- .github/workflows/provision-darwin.sh
10+
- .github/workflows/provision-linux.sh
11+
- .github/workflows/motoko-backend-only-example.yml
12+
- .ic-commit
13+
concurrency:
14+
group: ${{ github.workflow }}-${{ github.ref }}
15+
cancel-in-progress: true
16+
jobs:
17+
motoko-backend-only-darwin:
18+
runs-on: macos-15
19+
steps:
20+
- uses: actions/checkout@v1
21+
- name: Provision Darwin
22+
run: bash .github/workflows/provision-darwin.sh
23+
- name: Motoko Backend Only Darwin
24+
run: |
25+
dfx start --background
26+
pushd motoko/backend_only
27+
make test
28+
popd
29+
motoko-backend-only-linux:
30+
runs-on: ubuntu-22.04
31+
steps:
32+
- uses: actions/checkout@v1
33+
- name: Provision Linux
34+
run: bash .github/workflows/provision-linux.sh
35+
- name: Motoko Backend Only Linux
36+
run: |
37+
dfx start --background
38+
pushd motoko/backend_only
39+
make test
40+
popd

‎motoko/backend_only/BUILD.md‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
# Continue building locally
2+
3+
Projects deployed through ICP Ninja are temporary; they will only be live for 20 minutes before they are removed. The command-line tool `dfx` can be used to continue building your ICP Ninja project locally and deploy it to the mainnet.
4+
5+
To migrate your ICP Ninja project off of the web browser and develop it locally, follow these steps.
6+
7+
### 1. Install developer tools.
8+
9+
You can install the developer tools natively or use Dev Containers.
10+
11+
#### Option 1: Natively install developer tools
12+
13+
> Installing `dfx` natively is currently only supported on macOS and Linux systems. On Windows, it is recommended to use the Dev Containers option.
14+
15+
1. Install `dfx` with the following command:
16+
17+
```
18+
19+
sh -ci "$(curl -fsSL https://internetcomputer.org/install.sh)"
20+
21+
```
22+
23+
> On Apple Silicon (e.g., Apple M1 chip), make sure you have Rosetta installed (`softwareupdate --install-rosetta`).
24+
25+
2. [Install NodeJS](https://nodejs.org/en/download/package-manager).
26+
27+
3. For Rust projects, you will also need to:
28+
29+
- Install [Rust](https://doc.rust-lang.org/cargo/getting-started/installation.html#install-rust-and-cargo): `curl https://sh.rustup.rs -sSf | sh`
30+
31+
- Install [candid-extractor](https://crates.io/crates/candid-extractor): `cargo install candid-extractor`
32+
33+
4. For Motoko projects, you will also need to:
34+
35+
- Install the Motoko package manager [Mops](https://docs.mops.one/quick-start#2-install-mops-cli): `npm i -g ic-mops`
36+
37+
Lastly, navigate into your project's directory that you downloaded from ICP Ninja.
38+
39+
#### Option 2: Dev Containers
40+
41+
Continue building your projects locally by installing the [Dev Container extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) for VS Code and [Docker](https://docs.docker.com/engine/install/).
42+
43+
Make sure Docker is running, then navigate into your project's directory that you downloaded from ICP Ninja and start the Dev Container by selecting `Dev-Containers: Reopen in Container` in VS Code's command palette (F1 or Ctrl/Cmd+Shift+P).
44+
45+
> Note that local development ports (e.g. the ports used by `dfx` or `vite`) are forwarded from the Dev Container to your local machine. In the VS code terminal, use Ctrl/Cmd+Click on the displayed local URLs to open them in your browser. To view the current port mappings, click the "Ports" tab in the VS Code terminal window.
46+
47+
### 2. Create a local developer identity.
48+
49+
To manage your project's canisters, it is recommended that you create a local [developer identity](https://internetcomputer.org/docs/building-apps/getting-started/identities) rather than use the `dfx` default identity that is not stored securely.
50+
51+
To create a new identity, run the commands:
52+
53+
```
54+
55+
dfx start --background
56+
57+
dfx identity new IDENTITY_NAME
58+
59+
dfx identity use IDENTITY_NAME
60+
61+
```
62+
63+
Replace `IDENTITY_NAME` with your preferred identity name. The first command `dfx start --background` starts the local `dfx` processes, then `dfx identity new` will create a new identity and return your identity's seed phase. Be sure to save this in a safe, secure location.
64+
65+
The third command `dfx identity use` will tell `dfx` to use your new identity as the active identity. Any canister smart contracts created after running `dfx identity use` will be owned and controlled by the active identity.
66+
67+
Your identity will have a principal ID associated with it. Principal IDs are used to identify different entities on ICP, such as users and canisters.
68+
69+
[Learn more about ICP developer identities](https://internetcomputer.org/docs/building-apps/getting-started/identities).
70+
71+
### 3. Deploy the project locally.
72+
73+
Deploy your project to your local developer environment with:
74+
75+
```
76+
npm install
77+
dfx deploy
78+
79+
```
80+
81+
Your project will be hosted on your local machine. The local canister URLs for your project will be shown in the terminal window as output of the `dfx deploy` command. You can open these URLs in your web browser to view the local instance of your project.
82+
83+
### 4. Obtain cycles.
84+
85+
To deploy your project to the mainnet for long-term public accessibility, first you will need [cycles](https://internetcomputer.org/docs/building-apps/getting-started/tokens-and-cycles). Cycles are used to pay for the resources your project uses on the mainnet, such as storage and compute.
86+
87+
> This cost model is known as ICP's [reverse gas model](https://internetcomputer.org/docs/building-apps/essentials/gas-cost), where developers pay for their project's gas fees rather than users pay for their own gas fees. This model provides an enhanced end user experience since they do not need to hold tokens or sign transactions when using a dapp deployed on ICP.
88+
89+
> Learn how much a project may cost by using the [pricing calculator](https://internetcomputer.org/docs/building-apps/essentials/cost-estimations-and-examples).
90+
91+
Cycles can be obtained through [converting ICP tokens into cycles using `dfx`](https://internetcomputer.org/docs/building-apps/developer-tools/dfx/dfx-cycles#dfx-cycles-convert).
92+
93+
### 5. Deploy to the mainnet.
94+
95+
Once you have cycles, run the command:
96+
97+
```
98+
99+
dfx deploy --network ic
100+
101+
```
102+
103+
After your project has been deployed to the mainnet, it will continuously require cycles to pay for the resources it uses. You will need to [top up](https://internetcomputer.org/docs/building-apps/canister-management/topping-up) your project's canisters or set up automatic cycles management through a service such as [CycleOps](https://cycleops.dev/).
104+
105+
> If your project's canisters run out of cycles, they will be removed from the network.
106+
107+
## Additional examples
108+
109+
Additional code examples and sample applications can be found in the [DFINITY examples repo](https://github.com/dfinity/examples).

‎motoko/backend_only/Makefile‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
.PHONY: all
2+
all: build
3+
4+
.PHONY: node_modules
5+
.SILENT: node_modules
6+
node_modules:
7+
npm install
8+
9+
.PHONY: build
10+
.SILENT: build
11+
build: node_modules
12+
dfx canister create --all
13+
dfx build
14+
15+
.PHONY: install
16+
.SILENT: install
17+
install: build
18+
dfx canister install --all
19+
20+
.PHONY: upgrade
21+
.SILENT: upgrade
22+
upgrade: build
23+
dfx canister install --all --mode=upgrade
24+
25+
.PHONY: test
26+
.SILENT: test
27+
test: install
28+
dfx canister call backend greet '("world")' \
29+
| grep '("Hello, world!")' && echo 'PASS'
30+
31+
.PHONY: clean
32+
.SILENT: clean
33+
clean:
34+
rm -fr .dfx

‎motoko/backend_only/README.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Hello, world!
2+
3+
This variation of "Hello, world!" is written in [Motoko](https://internetcomputer.org/docs/motoko/main/getting-started/motoko-introduction), a programming language designed specifically for developing canisters on ICP.
4+
5+
## Project structure
6+
7+
The `/backend` folder contains the Motoko canister, `app.mo`. Edit the `mops.toml` file to add [Motoko dependencies](https://mops.one/) to the project.
8+
9+
## Deploying from ICP Ninja
10+
11+
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.
12+
To open this project in ICP Ninja, click [here](https://icp.ninja/i?url=https://github.com/dfinity/examples/tree/master/motoko/backend_only).
13+
14+
To **download** or **reset** the project files, click the menu option next to the deploy button.
15+
16+
## Build and deploy from the command-line
17+
18+
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+
### 1. Download your project from ICP Ninja using the 'Download files' button on the upper left corner under the pink ninja star icon.
21+
22+
### 2. Open the `BUILD.md` file for further instructions.

‎motoko/backend_only/backend/app.mo‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
persistent actor HelloWorld {
2+
public query func greet(name : Text) : async Text {
3+
return "Hello, " # name # "!";
4+
};
5+
};

‎motoko/backend_only/devcontainer.json‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"name": "ICP Dev Environment",
3+
"image": "ghcr.io/dfinity/icp-dev-env-slim:17",
4+
"forwardPorts": [4943, 5173],
5+
"portsAttributes": {
6+
"4943": {
7+
"label": "dfx",
8+
"onAutoForward": "ignore"
9+
},
10+
"5173": {
11+
"label": "vite",
12+
"onAutoForward": "openBrowser"
13+
}
14+
},
15+
"customizations": {
16+
"vscode": {
17+
"extensions": ["dfinity-foundation.vscode-motoko"]
18+
}
19+
}
20+
}

‎motoko/backend_only/dfx.json‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"canisters": {
3+
"backend": {
4+
"main": "backend/app.mo",
5+
"type": "motoko",
6+
"args": "--enhanced-orthogonal-persistence"
7+
}
8+
},
9+
"defaults": {
10+
"build": {
11+
"packtool": "mops sources"
12+
}
13+
}
14+
}

‎motoko/backend_only/mops.toml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Motoko dependencies (https://mops.one/)
2+
3+
[dependencies]
4+
base = "0.14.1"

0 commit comments

Comments
 (0)