cherry-styled-components 0.1.0-5 → 0.1.0-7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -13
- package/package.json +3 -2
- package/src/lib/utils/theme.ts +1 -0
package/README.md
CHANGED
|
@@ -1,26 +1,36 @@
|
|
|
1
|
-
# Cherry
|
|
1
|
+
# Cherry React Library
|
|
2
|
+
|
|
2
3
|
## Introduction
|
|
3
|
-
The **Cherry Design System** is a versatile foundation for your projects. As a starting point, it provides a clean slate—a white label—upon which you can build and extend. Whether you’re creating a web application, mobile app, or any other digital interface, Cherry defines the essential components you need.
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
- **Theming Support**: Cherry embraces theming, enabling you to adapt the design system to different contexts while maintaining consistency.
|
|
9
|
-
Sanity and Consistency: By adhering to Cherry’s guidelines, you’ll create a cohesive user experience across various screens and interactions.
|
|
10
|
-
- **Open Source**: Cherry takes it a step further by providing ready-to-use source code for the **Figma designs**. This means you not only get the visual templates but also the actual implementation. It’s like having a bridge between your design tool and your codebase.
|
|
5
|
+
The Cherry Design System is a versatile foundation for projects. It offers a white label base, ready-to-use Figma designs, React components, theming support and is open source. Explore the [documentation](https://cherry.design/) to create delightful user interfaces.
|
|
6
|
+
|
|
7
|
+
---
|
|
11
8
|
|
|
12
|
-
|
|
13
|
-
To begin using Cherry, refer to our comprehensive documentation at [cherry.design](https://cherry.design/). Explore the components, study the design principles, and integrate them seamlessly into your project. Remember, Cherry is not just a set of rules—it’s a toolkit that empowers you to create delightful user interfaces.
|
|
9
|
+
# Installation
|
|
14
10
|
|
|
15
|
-
|
|
11
|
+
This project requires Node.js v20+ installed.
|
|
16
12
|
|
|
17
|
-
|
|
13
|
+
```bash
|
|
14
|
+
npm install
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
To run the development environment, use the following command:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npm run dev
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
To build the library for production, use the following command:
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
npm run build
|
|
27
|
+
```
|
|
18
28
|
|
|
19
29
|
## Community
|
|
20
30
|
|
|
21
31
|
For help, discussion about best practices, or any other conversation that would benefit from being searchable:
|
|
22
32
|
|
|
23
|
-
[Discuss Cherry
|
|
33
|
+
[Discuss Cherry on GitHub](https://github.com/cherry-design-system/styled-components/discussions)
|
|
24
34
|
|
|
25
35
|
For casual chit-chat with others using Cherry:
|
|
26
36
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "cherry-styled-components",
|
|
3
|
-
"version": "0.1.0-
|
|
3
|
+
"version": "0.1.0-7",
|
|
4
4
|
"private": false,
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/cherry.umd.cjs",
|
|
@@ -36,7 +36,8 @@
|
|
|
36
36
|
"@vitejs/plugin-react": "^4.2.1",
|
|
37
37
|
"eslint": "^8.57.0",
|
|
38
38
|
"eslint-plugin-react-hooks": "^4.6.0",
|
|
39
|
-
"eslint-plugin-react-refresh": "^0.4.
|
|
39
|
+
"eslint-plugin-react-refresh": "^0.4.6",
|
|
40
|
+
"next": "^14.1.3",
|
|
40
41
|
"polished": "^4.3.1",
|
|
41
42
|
"prettier": "^3.2.5",
|
|
42
43
|
"styled-components": "^6.1.8",
|
package/src/lib/utils/theme.ts
CHANGED