https://github.com/ceramicstudio/create-ceramic-app
https://github.com/ceramicstudio/create-ceramic-app
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/ceramicstudio/create-ceramic-app
- Owner: ceramicstudio
- License: mit
- Created: 2022-08-22T18:20:06.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-05T15:35:22.000Z (almost 2 years ago)
- Last Synced: 2025-04-07T23:51:10.008Z (about 1 year ago)
- Language: TypeScript
- Size: 4.33 MB
- Stars: 7
- Watchers: 3
- Forks: 6
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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:
```sh-session
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:
```sh-session
cd
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/](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](https://developers.ceramic.network/docs/composedb/set-up-your-environment#installation-using-wheel)
## Contributing
Contributions are always welcome! Please create a PR & the Ceramic Network Team will review & provide feedback.