Skip to content

Commit e60c6a7

Browse files
Update README.md
1 parent e041003 commit e60c6a7

File tree

1 file changed

+32
-26
lines changed

1 file changed

+32
-26
lines changed

README.md

+32-26
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,50 @@
1-
## DFINITY Examples for the Internet Computer
1+
# Internet Computer sample applications
22

3-
This repository provides access to sample code, applications, and microservices that run on the Internet Computer platform.
3+
Get started building on ICP with the sample applications in this repository.
44

5-
From this repository, you can download, clone, fork, or share sample projects.
5+
From this repository, you can deploy, download, clone, fork, or share sample projects.
66

7-
You will also be able to contribute your own project or suggest updates to published projects using the standard Git work flow.
8-
9-
Sample projects provide a way for you to experiment and collaborate with other developers.
107
The projects and sample code are not, however, intended to be used as commercial applications and do not provide any explicit or implied support or warranty of any kind.
118

12-
To get started:
9+
You can also contribute your own project or suggest updates to published projects using the standard GitHub workflow.
10+
11+
## Deploying samples
12+
13+
### GitHub Codespaces or Gitpod
14+
15+
This repo can be opened in a web-based developer environment such as [GitHub Codespaces](https://github.com/codespaces) or [Gitpod](https://www.gitpod.io/), allowing you to edit and deploy the sample projects without downloading any tools or setting up a local environment.
16+
17+
[Get started with GitHub codespaces](https://internetcomputer.org/docs/current/developer-docs/developer-tools/ide/codespaces).
18+
19+
[Get started with Gitpod](https://internetcomputer.org/docs/current/developer-docs/developer-tools/ide/gitpod).
20+
21+
### Motoko Playground
1322

14-
1. Open a terminal shell on your local computer.
23+
Motoko Playground is a web-based developer environment for Motoko projects. To use Motoko Playground, navigate to the [playground UI](https://m7sm4-2iaaa-aaaab-qabra-cai.ic0.app/) and select a template to get started, or start a new project.
1524

16-
1. Download the DFINITY Canister SDK, if needed:
25+
### dfx
1726

18-
```
19-
sh -ci "$(curl -fsSL https://internetcomputer.org/install.sh)"
20-
```
27+
dfx is a command-line tool used to create, deploy. and manage projects on ICP. To download and use dfx with this examples repo, run the following commands locally (macOS/Linux systems):
2128

22-
1. Select a language—for example, `c` or `motoko`—to explore the examples available in the language of your choice.
29+
```
30+
git clone https://github.com/dfinity/examples.git
31+
cd examples
32+
sh -ci "$(curl -fsSL https://internetcomputer.org/install.sh)"
33+
```
2334

24-
1. Clone the repository to download the `examples` repo to your local workspace.
35+
Then, navigate into the folder of the sample that you want to use and follow the project's README instructions to setup and deploy the sample code.
2536

26-
1. Open the project folder for the example you want to use.
2737

28-
1. Start a local internet computer replica by running the following command:
38+
## Resources
2939

30-
```
31-
dfx start
32-
```
40+
- [ICP Developer Docs](https://internetcomputer.org/docs/current/home)
3341

34-
1. Open a new terminal shell on your local computer.
42+
- [Overview of ICP](https://internetcomputer.org/docs/current/developer-docs/getting-started/overview-of-icp)
3543

36-
1. Build the sample project by running the following command:
44+
- [Installing dfx](https://internetcomputer.org/docs/current/developer-docs/getting-started/install/)
3745

38-
```
39-
dfx build
40-
```
46+
- [Developer tools](https://internetcomputer.org/docs/current/developer-docs/developer-tools/dev-tools-overview)
4147

42-
## Security Considerations and Best Practices
48+
## Security considerations and best practices
4349

44-
If you base your application on one of these examples, we recommend you familiarize yourself with and adhere to the [Security Best Practices](https://internetcomputer.org/docs/current/references/security/) for developing on the Internet Computer. The examples provided here may not implement all the best practices.
50+
If you base your application on one of these examples, we recommend you familiarize yourself with and adhere to the [security best practices](https://internetcomputer.org/docs/current/references/security/) for developing on the Internet Computer. The examples provided here may not implement all the best practices.

0 commit comments

Comments
 (0)