https://github.com/ceramicnetwork/js-ceramic
Typescript implementation of the Ceramic protocol
https://github.com/ceramicnetwork/js-ceramic
ceramic javascript typescript
Last synced: 11 months ago
JSON representation
Typescript implementation of the Ceramic protocol
- Host: GitHub
- URL: https://github.com/ceramicnetwork/js-ceramic
- Owner: ceramicnetwork
- License: other
- Created: 2020-02-25T10:20:36.000Z (about 6 years ago)
- Default Branch: develop
- Last Pushed: 2025-03-19T19:42:00.000Z (about 1 year ago)
- Last Synced: 2025-05-03T01:44:04.811Z (11 months ago)
- Topics: ceramic, javascript, typescript
- Language: TypeScript
- Homepage: http://ceramic.network
- Size: 67.9 MB
- Stars: 416
- Watchers: 17
- Forks: 129
- Open Issues: 77
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# js-ceramic
[](https://lbesson.mit-license.org/)
[](https://discord.gg/6VRZpGP)
[](https://twitter.com/ceramicnetwork)
**js-ceramic** is a monorepo containing the TypeScript implementation of the Ceramic protocol. If you are unfamiliar with Ceramic, see the [website](https://ceramic.network) or [overview](https://developers.ceramic.network/learn/welcome/) for more information.
> **Project status**: **Access the Ceramic mainnet. 🚀**
> With the launch of [ComposeDB Beta](https://blog.ceramic.network/composedb-is-live-on-ceramic-mainnet/), it is now much easier to access Ceramic mainnet for building applications.
> Developers can now onboard their node to Ceramic mainnet in under 5 minutes without needing to contact any community members. Check out [this guide](https://composedb.js.org/docs/0.5.x/guides/composedb-server/access-mainnet)
> to learn more.
## Clients
`js-ceramic` provides three JavaScript clients that offer different ways to interact with the Ceramic network.
| Client | Package | Description | Current Version |
| ------ | --------------------------- | ---------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| Core | @ceramicnetwork/core | Full JavaScript protocol implementation | [](https://www.npmjs.com/package/@ceramicnetwork/core) |
| CLI | @ceramicnetwork/cli | CLI and HTTP daemon | [](https://www.npmjs.com/package/@ceramicnetwork/cli) |
| HTTP | @ceramicnetwork/http-client | HTTP client that can interact with a remote Ceramic daemon | [](https://www.npmjs.com/package/@ceramicnetwork/http-client) |
> For performance reasons it is recommended that you use the HTTP client if you are building an application.
## Installation and usage
Full protocol documentation can be found on the [Ceramic documentation site →](https://developers.ceramic.network/protocol/overview/).
[Quickstart to run a ceramic node](docs-dev/QUICKSTART.md)
### Upgrading
[Upgrade a ceramic node to latest version](docs-dev/UPGRADING.md)
## Troubleshooting
- For technical questions and support: [Join the Ceramic Forum](https://forum.ceramic.network/)
- For bugs and feature requests: [Create an issue on Github](https://github.com/ceramicnetwork/js-ceramic/issues)
## Contributing
We are happy to accept small and large contributions, feel free to make a suggestion or submit a pull request.
Check out the [Development](./DEVELOPMENT.md) section to learn how to navigate the code in this repo.
## Maintainers
- Spencer ([@stbrody](https://github.com/stbrody))
## License
Fully open source and dual-licensed under MIT and Apache 2.
