ceramicstudio / create-ceramic-app Goto Github PK

View Code? Open in Web Editor NEW

6.0 3.0 5.0 4.43 MB

License: MIT License

JavaScript 4.27% Batchfile 1.28% TypeScript 94.46%

create-ceramic-app's Introduction

Create Ceramic App CLI

CLI for downloading, installing and launching a ComposeDB Example App from Ceramic.

Usage

`create-ceramic-app`

Run this command to create a new example app:

npx create-ceramic-app

You will be guided through the process and in the end you'll have a new folder with your app.

The app will be ready to run with just this one command above but during the configuration process you can choose to only install the app and choose to launch it later.

If you choose to launch it later, you can run the app with this command:

cd <your-app-name>
npm run dev

This will start the app and you'll be able to access it at http://localhost:3000

🎉 Happy hacking!

Support

If you have any questions or just want to hang out with others building on Ceramic, our Forum is a great place to start: https://forum.ceramic.network/

Next steps

The example app runs Ceramic locally, in memory. This is the easiest and the fastest way to get started with Ceramic. However, if you want to run Ceramic in a more production-like environment, you can launch a Ceramic node on testnet or mainnet.

To properly configure all the aspects of your Ceramic environment for this, please use Wheel to generate a development environment.

Instructions for Wheel

Contributing

Contributions are always welcome! Please create a PR & the Ceramic Network Team will review & provide feedback.

create-ceramic-app's People

Stargazers

Watchers

Forkers

0xjjpa justinapetr mashharuki techieteee mzkrasner

create-ceramic-app's Issues

Unable to load model on startup - Missing `simpleProfile` model (IPFS daemon port `7007`)

Background

Previously, I've run npm run dev successfully to do the entire workflow of the Create Ceramic App demo (i.e., update profile information, submit, do with another wallet, query via ComposeDB graphl query). However, for the past two days, I have not been able to do so successfully anymore, getting the following error.

For context, I'm loading this via Gitpod, although I've done it w/o any issues previously.

Steps to replicate

Go to https://gitpod.io/https://github.com/ceramicstudio/create-ceramic-app
Clone the template, install the deps, install @ceramicnetwork/cli globally (see #20) and run npm run dev
See error shown above.

Additional details

Sometimes I can import it manually via composedb composite:deploy src/__generated__/definition.json --ceramic-url=http://localhost:7007 --did-private-key=$(cat admin_seed.txt) but not always successfully (i.e., sometimes I get an ECONNREFUSED error as if the service were down). It would be interesting to figure out why that is the case.

Error: command Symbol(SINGLE_COMMAND_CLI) not found

Versions

node -v
v20.13.1

npm -v
10.5.2

bun -v
1.1.8

Run bunx create-ceramic-app

 ›   Error: command Symbol(SINGLE_COMMAND_CLI) not found

Run npx create-ceramic-app

 ›   Error: command Symbol(SINGLE_COMMAND_CLI) not found

Issues when running `npm run dev`

When running npm run dev the following error shows up instead of starting the actual Ceramic stack.

> [email protected] dev
> node scripts/run.mjs

⠸ [Ceramic] Starting Ceramic node
[Ceramic] 
> [email protected] ceramic
> CERAMIC_ENABLE_EXPERIMENTAL_COMPOSE_DB='true' npx ceramic daemon --config ./composedb.config.json

✖ [Ceramic] Ceramic node failed to start with error:
✖ [Ceramic] npm

This is likely due to the script expecting ceramic to be exposed globally.