Skip to content

Commit 9896893

Browse files
authored
Update create-ceramic-app.mdx
1 parent 8d4a056 commit 9896893

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

docs/composedb/create-ceramic-app.mdx

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,35 @@ Get up and running quickly with a basic ComposeDB application with one command.
1111
- **Node.js v20** - If you are using a different version, please use `nvm` to install Node.js v20 for best results.
1212
- **npm v10** - Installed automatically with NodeJS v20
1313

14+
You will also need to run a ceramic-one node in the background which provides Ceramic
15+
data network access. To set it up, follow the steps below:
16+
17+
:::note
18+
The instructions below cover the steps for the MacOS-based systems. If you are running on a Linux-based system, you can find the
19+
instructions [here](https://github.com/ceramicnetwork/rust-ceramic?tab=readme-ov-file#linux---debian-based-distributions).
20+
:::
21+
22+
1. Install the component using [Homebrew](https://brew.sh/):
23+
24+
```bash
25+
brew install ceramicnetwork/tap/ceramic-one
26+
```
27+
28+
2. Start the `ceramic-one` using the following command:
29+
```bash
30+
ceramic-one daemon --network in-memory
31+
```
32+
33+
:::note
34+
By default, the command above will spin off a node which connects to a `in-memory`. You can change this behaviour by providing a `--network` flag and specifying a network of your choice. For example:
35+
36+
```ceramic-one daemon --network testnet-clay```
37+
:::
38+
39+
---
40+
41+
## Start the ComposeDB example app
42+
1443
You can easily create a simple ComposeDB starter project by using our CLI and running the following command:
1544

1645
<Tabs

0 commit comments

Comments
 (0)