Skip to content

Commit ce16d95

Browse files
committed
Add CodeSignal design system integration as git submodule
1 parent e320e0e commit ce16d95

File tree

7 files changed

+517
-821
lines changed

7 files changed

+517
-821
lines changed

.gitmodules

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

README.md

Lines changed: 24 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,36 @@
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. `client/bespoke.css`
8-
The core CSS framework providing:
9-
- Consistent design tokens (colors, spacing, typography)
10-
- Light and dark theme support
11-
- Reusable component styles (buttons, forms, modals, cards)
12-
- Responsive design utilities
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
11+
- See the [design system repository](https://github.com/CodeSignal/learn_bespoke-design-system) for full documentation
1312

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

21-
### 3. `client/help-modal.js`
26+
### 4. `client/help-modal.js`
2227
A dependency-free JavaScript module for the help modal system:
2328
- Consistent modal behavior across all apps
2429
- Keyboard navigation (ESC to close)
2530
- Focus management
2631
- Custom event system
2732

28-
### 4. `client/help-content-template.html`
33+
### 5. `client/help-content-template.html`
2934
A template for creating consistent help content:
3035
- Table of contents navigation
3136
- Standardized section structure
@@ -45,8 +50,14 @@ A template for creating consistent help content:
4550
- `<!-- APP_SPECIFIC_CSS -->` - Links to your app-specific CSS files
4651
- `<!-- APP_SPECIFIC_SCRIPTS -->` - Links to your app-specific JavaScript files
4752

48-
3. **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.
49-
4. **Customise your help content** using the help content template
53+
3. **Use Design System Components**
54+
The template uses design system components directly. Use these classes:
55+
- Buttons: `button button-primary`, `button button-secondary`, `button button-danger`, `button button-text`
56+
- Boxes/Cards: `box card` for card containers
57+
- Inputs: Add `input` class to input elements: `<input type="text" class="input" />`
58+
59+
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.
60+
5. **Customise your help content** using the help content template
5061

5162
### Customizing Help Content
5263

@@ -57,27 +68,6 @@ Use the `help-content-template.html` as a starting point:
5768
3. **Include images** by placing them in a `help/img/` directory
5869
4. **Use the provided structure** for consistency across applications
5970

60-
### CSS Customization
61-
62-
The `bespoke.css` file uses CSS custom properties for easy theming:
63-
64-
```css
65-
.bespoke {
66-
--bespoke-accent: #1062fb; /* Primary accent color */
67-
--bespoke-bg: #ffffff; /* Background color */
68-
--bespoke-fg: rgb(24, 33, 57); /* Text color */
69-
/* ... many more variables */
70-
}
71-
```
72-
73-
You can override these variables in your app-specific CSS:
74-
75-
```css
76-
.my-app {
77-
--bespoke-accent: #ff6b6b; /* Custom accent color */
78-
--bespoke-bg: #f8f9fa; /* Custom background */
79-
}
80-
```
8171

8272
### Help Modal API
8373

0 commit comments

Comments
 (0)