https://github.com/ceramicstudio/composedbexampleapp
https://github.com/ceramicstudio/composedbexampleapp
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/ceramicstudio/composedbexampleapp
- Owner: ceramicstudio
- Created: 2023-02-17T19:54:55.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-14T15:41:11.000Z (over 2 years ago)
- Last Synced: 2023-12-14T16:52:35.706Z (over 2 years ago)
- Language: TypeScript
- Size: 1.59 MB
- Stars: 4
- Watchers: 4
- Forks: 2
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ComposeDB Example App instructions
Due to the nature of the Ceramic Daemon certain files must be updated to work with your local machine. Please follow the following directions carefully to ensure functionality.
This demo uses Ceramic-One (Rust implementation of Ceramic's synchronization layer). As such, running this demo will require Ceramic-One running in the background. The following instructions will include corresponding Ceramic-One instructions.
## Getting Started
1. Install and start up Ceramic-One.
There are multiple ways to do so listed in the [README](https://github.com/ceramicnetwork/rust-ceramic) of the repository, contingent on your local environment. Please follow whichever instructions apply to your machine. Once installed, start the daemon using the instructions found in the [Usage](https://github.com/ceramicnetwork/rust-ceramic?tab=readme-ov-file#usage) section.
2. Back in the root directory of this repository, run `npm install` to install the packages
3. Start the development server with `npm run dev` once. You may continue to use this command if you'd like however it will close all Ceramic connections at the first error. It is recommended that once your node is configured to index the required models that you run `npm run ceramic` & `npm run nextDev` separately to avoid this eager quitting.
4. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
5. Enjoy this demo application!
## Learn More
Upgrade this project to claynet to see other developer's posts! Check out wheel to install ceramic / composeDB locally:
https://github.com/ceramicstudio/wheel
To learn more about Ceramic please visit the following links
- [Ceramic Documentation](https://developers.ceramic.network/learn/welcome/) - Learn more about the Ceramic Ecosystem.
- [ComposeDB](https://composedb.js.org/) - Details on how to use and develop with ComposeDB!
You can check out [Create Ceramic App repo](https://github.com/ceramicstudio/create-ceramic-app) and provide us with your feedback or contributions!