@sme.up/ketchup2 2.0.0-SNAPSHOT-20251230142017 → 2.0.0-SNAPSHOT-20251231114925
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 +14 -28
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,43 +1,29 @@
|
|
|
1
1
|
# Ketchup Next Gen
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Ketchup2 is a **TypeScript-first React component library** designed specifically for Smeup business applications. It provides:
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
- **Pre-built UI components** organized by domain (basic, functional, and complex components)
|
|
6
|
+
- **Data-driven architecture** that works seamlessly with Smeup data structures
|
|
7
|
+
- **Design system integration** with consistent tokens for colors, spacing, and typography
|
|
8
|
+
- **Comprehensive documentation** via Storybook and MDX guides
|
|
9
|
+
- **Full test coverage** with unit and visual regression testing
|
|
6
10
|
|
|
7
|
-
|
|
11
|
+
**Key Focus:** Building enterprise-grade business UIs with Smeup-specific data patterns and accessibility in mind.
|
|
12
|
+
|
|
13
|
+
## Getting started
|
|
14
|
+
|
|
15
|
+
See [prerequisite](docs/PREREQUISITES.md) and [Init docs page](docs/INIT.md) to start working on the library.
|
|
8
16
|
|
|
9
17
|
## Development
|
|
10
18
|
|
|
11
|
-
See [
|
|
19
|
+
See [Project Structure](docs/PROJECT-STRUCTURE.md) to learn how the project is structured.
|
|
20
|
+
See [Styleguide](docs/STYLEGUIDE.md) to learn our convention.
|
|
21
|
+
See [First Example](docs/FIRST-EXAMPLE.md) to gain confidence creating your first component
|
|
12
22
|
|
|
13
23
|
## Validation
|
|
14
24
|
|
|
15
25
|
See [Development Process](docs/DEVPROCESS.md)
|
|
16
26
|
|
|
17
|
-
## Getting Started
|
|
18
|
-
|
|
19
|
-
Install dependencies:
|
|
20
|
-
|
|
21
|
-
```
|
|
22
|
-
npm install
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
Start project:
|
|
26
|
-
|
|
27
|
-
```
|
|
28
|
-
npm run dev
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
Execute test:
|
|
32
|
-
|
|
33
|
-
```
|
|
34
|
-
# Node tests
|
|
35
|
-
npm run test:node
|
|
36
|
-
|
|
37
|
-
# Component tests
|
|
38
|
-
npm run test:dom
|
|
39
|
-
```
|
|
40
|
-
|
|
41
27
|
## Shapes and Components
|
|
42
28
|
|
|
43
29
|
If you want to know what shapes/components are currently supported you can checkout here:
|
package/package.json
CHANGED