Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 21 additions & 46 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,30 @@
# CSPR.design

> **Build faster with CSPR.design**
CSPR.design is a React-based UI component library powering the CSPR.suite application family, including [CSPR.live](https://cspr.live) and [Casper Wallet](https://casperwallet.io). It provides a consistent design language, reusable components, and shared styling utilities to ensure a cohesive user experience across products. CSPR.design enables faster development, easier maintenance, and a unified brand presence throughout the Casper Ecosystem.

A production-ready React UI component library for Casper blockchain applications. Part of the **CSPR Products Suite**, used by [cspr.live](https://cspr.live/), CSPR.market, and other major ecosystem projects.
✅ **Battle-tested** components from production apps \
✅ **Blockchain-focused** with Casper-specific utilities \
✅ **Consistent design** across the Casper ecosystem

[![Install](https://img.shields.io/badge/npm-github%3Amake--software%2Fcspr--design-blue)](https://github.com/make-software/cspr-design)
[![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue)](https://www.typescriptlang.org/)
[![Production](https://img.shields.io/badge/Production-Tested-green)](https://cspr.live)

---

## Get started in 5 minutes
## Get started

Install from NPM to access ready-to-use components that bring the beloved Casper community UI to your dApp. Save time on design and implementation with clean, consistent look tailored for Web3.

✅ **Battle-tested** components from production apps \
✅ **Blockchain-focused** with Casper-specific utilities \
✅ **Consistent design** across the Casper ecosystem

## Installation
Install from [NPM](https://www.npmjs.com/package/@make-software/cspr-design) to access ready-to-use components that bring the beloved [Casper blockchain](https://casper.network) community UI to your dApp:

```bash
npm install @make-software/cspr-design
```

## Quick Start
Save time on design and implementation with a consistent Casper Network look:

```jsx
import {
Cspr,
CSPR,
BodyText,
FlexColumn,
AccountInfo,
Expand All @@ -38,49 +34,28 @@ import {
const MyApp = () => (
<FlexColumn itemsSpacing={20}>
<BodyText size={2}>Account Balance:</BodyText>
<Cspr
<CSPR
motes="50000000000000"
precisionCase={PrecisionCase.full}
/>
<AccountInfo
accountHash="01a2b3c4d5e6f7..."
accountHash="200826c53eb84181e749681bc276f1d3a3f7e6dd76c5f260b77bb54a2b4590a9"
balance="1500000000"
/>
</FlexColumn>
);
```

## Perfect Match with CSPR Ecosystem

**🌐 [CSPR.cloud](https://docs.cspr.cloud/)** - Get blockchain data
**🔐 [CSPR.click](https://docs.cspr.click/)** - Handle wallet connections
**🎨 CSPR.design** - Build beautiful UIs

```jsx
// Data from CSPR.cloud + UI from CSPR.design = 🚀
const DeployInfo = ({ deploy }) => (
<FlexColumn itemsSpacing={16}>
<BodyText>Deploy Cost:</BodyText>
<Cspr motes={deploy.payment_amount} />
</FlexColumn>
);
```

## Check examples in the storybook
## Storybook examples

Explore live previews of every component, complete with usage guidelines and props. See how each UI element behaves in real-world scenarios. No guesswork, just plug and play.
Explore [CSPR.design Storybook](https://storybook.cspr.design) for live previews of every component, complete with usage guidelines and props. See how each UI element behaves in real-world scenarios. No guesswork, just plug and play.

```bash
# View components in Storybook
npm run build-storybook && npm run storybook
![CSPR.design Storybook](docs/images/storybook.png)

# Build library
npm run build:dist
```

### Troubleshooting
## Troubleshooting

**Vite + styled-components issue?** Add to your `vite.config.js`:
Please add the following to your `vite.config.js` if you are experiencing issues with `vite` and `styled-components`:

```js
resolve: {
Expand All @@ -96,17 +71,17 @@ resolve: {

## Resources

📖 **[Full Documentation](https://cspr.design/)** - Complete guide
🎨 **[Storybook](https://storybook.cspr.design/)** - Interactive components
🐛 **[Report Issues](https://github.com/make-software/cspr-design/issues)** - Bugs & features
💬 **[Community](telegram-url)** - Get help & discuss

📕 **[Storybook](https://storybook.cspr.design)**: Interactive examples
🐞 **[Report Issues](https://github.com/make-software/cspr-design/issues)**: Please report issues here
💬 **[Casper Telegram Community](https://t.me/CSPRDevelopers)**: Ask developers and fellow builders for help

---

<div align="center">

**Built by [MAKE](https://make.services) for the Casper ecosystem**
⭐ **Star this repo if CSPR.design helped you build something cool!**

⭐ **Star this repo if CSPR.design helped you build something cool!**

Built by [MAKE](https://makegroup.io) for the Casper ecosystem
</div>
Binary file added docs/images/storybook.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
50 changes: 0 additions & 50 deletions docs/overview.md

This file was deleted.

7 changes: 7 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,18 @@
{
"name": "@make-software/cspr-design",
"version": "2.0.0",
"description": "React-based UI component library powering Casper Blockchain applications",
"main": "dist/cspr-design.umd.js",
"module": "dist/cspr-design.es.js",
"types": "dist/lib/index.d.ts",
"type": "module",
"repository": "git://github.com/make-software/cspr-design",
"keywords": [
"casper",
"blockchain",
"react",
"web3"
],
"exports": {
".": {
"import": "./dist/cspr-design.es.js",
Expand Down
2 changes: 1 addition & 1 deletion src/01-Home.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ It provides a consistent design language, reusable components, and shared stylin

# Get started

Install from [NPM](https://www.npmjs.com/package/@make-software/cspr-design) to access ready-to-use components that bring the beloved [Casper blockchain](https://casper.networ) community UI to your dApp:
Install from [NPM](https://www.npmjs.com/package/@make-software/cspr-design) to access ready-to-use components that bring the beloved [Casper blockchain](https://casper.network) community UI to your dApp:

```
npm install @make-software/cspr-design --save
Expand Down