js-glaze
js-glaze copied to clipboard
Developer suite for building Ceramic applications
Glaze monorepo
Packages providing the JavaScript/TypeScript implementation of the Glaze ecosystem.
Installation
This monorepo uses Yarn workspaces, make sure to install it first if you don't already have it.
yarn installto install the dependenciesyarn buildto build all the packages
Additional scripts
yarn lintto run the linter in all packagesyarn testto run tests in all packagesyarn docsto generate API documentation
Packages
| Name | Description | Version |
|---|---|---|
| Runtime libraries | ||
@glazed/tile-loader |
Batching and caching for Ceramic streams | |
@glazed/datamodel |
Aliases for Ceramic stream references | |
@glazed/did-datastore |
Associate data records to a DID | |
| Developer tools | ||
@glazed/devtools |
Development tools library | |
@glazed/cli |
CLI | |
| Internal libraries | ||
@glazed/constants |
Shared constants | |
@glazed/did-datastore-model |
DataModel for the DID DataStore | |
@glazed/types |
Shared types | |
| Jest environments | ||
jest-environment-ceramic |
Ceramic environment for Jest tests | |
jest-environment-glaze |
Glaze environment for Jest tests |
Example
An example notes taking app using Glaze libraries and tools with a webpack setup is available in the examples/webpack-notes folder.
Maintainers
- Paul Le Cam (@paullecam)
License
Dual licensed under MIT and Apache 2