@rungalileo/jupiter-ds 0.0.1
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/LICENSE +22 -0
- package/README.md +118 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +73513 -0
- package/dist/index.js.map +1 -0
- package/dist/styles.css +2 -0
- package/dist/styles.css.map +1 -0
- package/dist/tsconfig.lib.tsbuildinfo +1 -0
- package/package.json +78 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 Rungalileo
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
22
|
+
|
package/README.md
ADDED
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
# ๐จ Jupiter Design System
|
|
2
|
+
|
|
3
|
+
A comprehensive React component library built with **Mantine v7** and **TypeScript**, following **Atomic Design** principles. Designed for scalability, accessibility, and developer experience within our Nx monorepo.
|
|
4
|
+
|
|
5
|
+

|
|
6
|
+

|
|
7
|
+

|
|
8
|
+

|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
## ๐ Table of Contents
|
|
13
|
+
|
|
14
|
+
- [๐จ Jupiter Design System](#-jupiter-design-system)
|
|
15
|
+
- [๐ Table of Contents](#-table-of-contents)
|
|
16
|
+
- [๐ Quick Start](#-quick-start)
|
|
17
|
+
- [Installation](#installation)
|
|
18
|
+
- [Basic Usage](#basic-usage)
|
|
19
|
+
- [๐๏ธ Architecture](#๏ธ-architecture)
|
|
20
|
+
- [Atomic Design Structure](#atomic-design-structure)
|
|
21
|
+
- [Design System Layers](#design-system-layers)
|
|
22
|
+
- [๐ Development](#-development)
|
|
23
|
+
- [Running Storybook](#running-storybook)
|
|
24
|
+
- [๐งช Testing](#-testing)
|
|
25
|
+
- [Unit Tests](#unit-tests)
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## ๐ Quick Start
|
|
30
|
+
|
|
31
|
+
### Installation
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
# The library is already installed in the monorepo
|
|
35
|
+
# Import components and themes directly
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### Basic Usage
|
|
39
|
+
|
|
40
|
+
```tsx
|
|
41
|
+
import { jupiterTheme, Button } from '@lib/jupiter-ds';
|
|
42
|
+
import { MantineProvider } from '@mantine/core';
|
|
43
|
+
|
|
44
|
+
function App() {
|
|
45
|
+
return (
|
|
46
|
+
<MantineProvider theme={jupiterTheme}>
|
|
47
|
+
<Button variant="filled" color="brand">
|
|
48
|
+
Hello Jupiter DS
|
|
49
|
+
</Button>
|
|
50
|
+
</MantineProvider>
|
|
51
|
+
);
|
|
52
|
+
}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
## ๐๏ธ Architecture
|
|
57
|
+
|
|
58
|
+
### Atomic Design Structure
|
|
59
|
+
|
|
60
|
+
```
|
|
61
|
+
src/lib/
|
|
62
|
+
โโโ ๐จ design-system/
|
|
63
|
+
โ โโโ tokens/ # Design tokens (colors, typography, spacing)
|
|
64
|
+
โ โโโ themes/ # Mantine theme configurations
|
|
65
|
+
โ โโโ foundations/ # CSS foundations and global styles
|
|
66
|
+
โโโ ๐งฉ components/
|
|
67
|
+
โโโ atoms/ # Basic building blocks (Button, Input)
|
|
68
|
+
โโโ molecules/ # Component combinations (SearchBar, Card)
|
|
69
|
+
โโโ organisms/ # Complex components (Header, Sidebar)
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### Design System Layers
|
|
73
|
+
|
|
74
|
+
1. **๐ฏ Design Tokens** - Raw design values (colors, spacing, typography)
|
|
75
|
+
2. **๐ญ Themes** - Mantine theme configuration with light/dark support
|
|
76
|
+
3. **๐๏ธ Foundations** - CSS reset, global styles, and base components
|
|
77
|
+
4. **๐งฉ Components** - React components following Atomic Design
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
## ๐ Development
|
|
83
|
+
|
|
84
|
+
### Running Storybook
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
# Start Storybook development server, which will run on port 6006
|
|
88
|
+
nx storybook jupiter-ds
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
## ๐งช Testing
|
|
92
|
+
|
|
93
|
+
### Unit Tests
|
|
94
|
+
|
|
95
|
+
```bash
|
|
96
|
+
# Run all tests
|
|
97
|
+
nx test jupiter-ds
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
<!-- ## ๐ค Contributing
|
|
101
|
+
|
|
102
|
+
### Adding New Components
|
|
103
|
+
|
|
104
|
+
1. Create component in appropriate atomic level (`atoms/`, `molecules/`, `organisms/`)
|
|
105
|
+
2. Include TypeScript interfaces
|
|
106
|
+
3. Add comprehensive Storybook stories
|
|
107
|
+
4. Write unit tests with React Testing Library
|
|
108
|
+
5. Export from `index.ts` files
|
|
109
|
+
|
|
110
|
+
### Design Token Updates
|
|
111
|
+
|
|
112
|
+
1. Update token files in `design-system/tokens/`
|
|
113
|
+
2. Regenerate theme configuration if needed
|
|
114
|
+
3. Test across all components in Storybook
|
|
115
|
+
4. Update documentation -->
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
**Built with โค๏ธ by the Galileo team**
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC"}
|