@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 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
+ ![Storybook](https://img.shields.io/badge/Storybook-FF4785?style=flat&logo=storybook&logoColor=white)
6
+ ![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=flat&logo=typescript&logoColor=white)
7
+ ![Mantine](https://img.shields.io/badge/Mantine-339AF0?style=flat&logo=mantine&logoColor=white)
8
+ ![Jest](https://img.shields.io/badge/Jest-C21325?style=flat&logo=jest&logoColor=white)
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**
@@ -0,0 +1,3 @@
1
+ export * from './lib/design-system';
2
+ export * from './lib/components';
3
+ //# sourceMappingURL=index.d.ts.map
@@ -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"}