Skip to content

Commit c892f1e

Browse files
committed
Add CodeSignal design system integration as git submodule
1 parent d05f464 commit c892f1e

File tree

7 files changed

+513
-726
lines changed

7 files changed

+513
-726
lines changed

.gitmodules

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
[submodule "design-system"]
1+
[submodule "client/design-system"]
22
path = client/design-system
33
url = https://github.com/CodeSignal/learn_bespoke-design-system.git

README.md

Lines changed: 22 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,37 @@
1-
# Bespoke Generalised Components
1+
# Bespoke Simulation Template
22

3-
This directory contains reusable components for creating embedded applications that share a consistent design system and user experience.
3+
This directory contains a template for creating embedded applications that share a consistent design system and user experience.
44

55
## Components
66

7-
### 1. Design System (Git Submodule)
8-
The design system is provided via a git submodule at `design-system/` and includes:
9-
- **Foundations**: Colors, spacing, and typography tokens
10-
- **Components**: Buttons, boxes, inputs, dropdowns, icons, and tags
7+
### 1. Design System Integration
8+
This template uses the CodeSignal Design System located in `client/design-system/`:
9+
- **Foundations**: Colors, spacing, typography tokens
10+
- **Components**: Buttons, boxes, inputs, dropdowns, tags
1111
- Light and dark theme support (automatic)
12-
- See `design-system/README.md` for full documentation
12+
- See the [design system repository](https://github.com/CodeSignal/learn_bespoke-design-system) for full documentation
1313

14-
### 2. `client/index.html`
14+
### 2. `client/bespoke-template.css`
15+
Template-specific CSS providing:
16+
- Layout components (header, sidebar, main-layout)
17+
- Utility classes (row, spacer, status)
18+
- Temporary components (modals, form elements) - will be replaced when design system adds them
19+
20+
### 3. `client/index.html`
1521
A base HTML template that includes:
1622
- Navigation header with app name and help button
1723
- Main layout structure (sidebar + content area)
1824
- Help modal integration
1925
- Proper CSS and JavaScript loading
2026

21-
### 3. `client/help-modal.js`
27+
### 4. `client/help-modal.js`
2228
A dependency-free JavaScript module for the help modal system:
2329
- Consistent modal behavior across all apps
2430
- Keyboard navigation (ESC to close)
2531
- Focus management
2632
- Custom event system
2733

28-
### 4. `client/help-content-template.html`
34+
### 5. `client/help-content-template.html`
2935
A template for creating consistent help content:
3036
- Table of contents navigation
3137
- Standardized section structure
@@ -50,6 +56,12 @@ A template for creating consistent help content:
5056
- `<!-- APP_SPECIFIC_CSS -->` - Links to your app-specific CSS files
5157
- `<!-- APP_SPECIFIC_SCRIPTS -->` - Links to your app-specific JavaScript files
5258

59+
3. **Use Design System Components**
60+
The template uses design system components directly. Use these classes:
61+
- Buttons: `button button-primary`, `button button-secondary`, `button button-danger`, `button button-text`
62+
- Boxes/Cards: `box card` for card containers
63+
- Inputs: Add `input` class to input elements: `<input type="text" class="input" />`
64+
5365
4. **Implement your application logic**. You can use Cursor or other agents for it. There is a file called `AGENTS.md` that contains context LLM can use.
5466
5. **Customise your help content** using the help content template
5567

@@ -62,25 +74,6 @@ Use the `help-content-template.html` as a starting point:
6274
3. **Include images** by placing them in a `help/img/` directory
6375
4. **Use the provided structure** for consistency across applications
6476

65-
### CSS Customization
66-
67-
The design system uses CSS custom properties for easy theming. You can override design system variables in your app-specific CSS:
68-
69-
```css
70-
:root {
71-
/* Override design system colors */
72-
--Colors-Base-Primary-700: #ff6b6b; /* Custom primary color */
73-
--Colors-Base-Neutral-00: #f8f9fa; /* Custom background */
74-
75-
/* Override spacing */
76-
--UI-Spacing-spacing-m: 20px;
77-
78-
/* Override typography */
79-
--Fonts-Body-Default-md: 16px;
80-
}
81-
```
82-
83-
See `design-system/README.md` and individual component READMEs for available variables.
8477

8578
### Help Modal API
8679

0 commit comments

Comments
 (0)