fildon / ceramic

React component library

Ceramic Components

A reusable React component library.

Try out the components right now at the Ceramic Components StoryBook.

Or you can view the source at the Ceramic Homepage.

Usage

Using Ceramic couldn't be simpler. Just add ceramic-components as a dependency to your project:

npm add ceramic-components

Or if you prefer NPM

npm install ceramic-components

Then wherever you would like to use a Ceramic component, for example:

import { Join } from "ceramic-components";

Since Ceramic was built in TypeScript, type declaration files are included. Thanks to this Ceramic works seamlessly in either JavaScript or TypeScript projects.

Development

Just install the project dependencies:

npm install

Then to run the StoryBook locally:

npm storybook:local

A StoryBook should appear, displaying all the current stories. This script supports hot module reloading, so feel free to change a component and see its stories update right away.

Linting

Linting is provided by ESLint and a handful of plugins. Additionally we recommend using Prettier.

You can run the linter with:

npm lint

Testing

Testing is provided by Jest and React Testing Library

You can run the tests with:

npm test

Or if you also want test coverage analysis:

npm test:coverage