You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**NOTE**: Use the `--ignore-scripts` flag because the chromedriver package attempts to download binaries during installation, which fails in restricted corporate networks (e.g., behind firewalls or proxies). This workaround prevents installation errors in such environments.
24
+
25
+
```bash
26
+
npm install --ignore-scripts
27
+
```
28
+
29
+
**NOTE**: Use the `--ignore-scripts` flag because the chromedriver package attempts to download binaries during installation, which fails in restricted corporate networks (e.g., behind firewalls or proxies). This workaround prevents installation errors in such environments.
25
30
26
31
3. **Decode DB Theme assets** (optional for basic development):
- **Build artifacts**: `packages/foundations/build/` and `packages/components/build/`
@@ -136,6 +156,7 @@ docker-compose --file ./e2e/docker-compose.yml up
136
156
```
137
157
138
158
### Package Scripts Reference
159
+
139
160
```bash
140
161
# Development
141
162
npm run dev # Interactive dev server (framework selection)
@@ -159,14 +180,25 @@ npm run generate:component # Generate new component scaffolding
159
180
## Known Issues and Workarounds
160
181
161
182
### Installation Issues
183
+
162
184
- **chromedriver fails**: Use `npm install --ignore-scripts` - this is expected in restricted network environments
163
185
- **Font decoding fails**: Expected with placeholder credentials - does not affect basic development
164
186
165
187
### Build Issues
188
+
166
189
- **Nuxt-related linting failures**: May fail if Nuxt showcase hasn't been run yet (requires `showcases/nuxt-showcase/.nuxt/tsconfig.json` to be generated)
167
190
- **Stencil warnings**: Component prop name conflicts are expected and documented
168
191
192
+
### Git hook issues
193
+
194
+
**Husky blocking git commit**: To prevent Husky blocking commits due to missing `COMMIT_MAIL` within `.env` file, just add `--no-verify` to your `git commit` command:
195
+
196
+
```bash
197
+
git commit -m "Your commit message" --no-verify
198
+
```
199
+
169
200
### Network Restrictions
201
+
170
202
- **Docker registry access**: E2E testing requires Docker and may need proxy configuration
171
203
- **Asset downloads**: DB Theme assets require valid credentials from Deutsche Bahn Marketing Portal
172
204
@@ -175,20 +207,23 @@ npm run generate:component # Generate new component scaffolding
175
207
If possible, start by writing a test that you could use to verify your solution, as well as we could use for ongoing regression testing throughout the product's development.
176
208
177
209
### Adding a New Component
210
+
178
211
1. `npm run generate:component` - Follow interactive prompts
# required to fetch internal or private CodeQL packs
36
+
packages: read
37
+
38
+
# only required for workflows in private repositories
39
+
actions: read
40
+
contents: read
41
+
42
+
strategy:
43
+
fail-fast: false
44
+
matrix:
45
+
include:
46
+
- language: actions
47
+
build-mode: none
48
+
- language: javascript-typescript
49
+
build-mode: none
50
+
# CodeQL supports the following values keywords for 'language': 'actions', 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'rust', 'swift'
51
+
# Use `c-cpp` to analyze code written in C, C++ or both
52
+
# Use 'java-kotlin' to analyze code written in Java, Kotlin or both
53
+
# Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
54
+
# To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
55
+
# see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
56
+
# If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
57
+
# your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
58
+
steps:
59
+
- name: Checkout repository
60
+
uses: actions/checkout@v5
61
+
62
+
# Add any setup steps before running the `github/codeql-action/init` action.
63
+
# This includes steps like installing compilers or runtimes (`actions/setup-node`
64
+
# or others). This is typically only required for manual builds.
65
+
# - name: Setup runtime (example)
66
+
# uses: actions/setup-example@v1
67
+
68
+
# Initializes the CodeQL tools for scanning.
69
+
- name: Initialize CodeQL
70
+
uses: github/codeql-action/init@v3
71
+
with:
72
+
languages: ${{ matrix.language }}
73
+
build-mode: ${{ matrix.build-mode }}
74
+
# If you wish to specify custom queries, you can do so here or in a config file.
75
+
# By default, queries listed here will override any specified in a config file.
76
+
# Prefix the list here with "+" to use these queries and those in the config file.
77
+
78
+
# For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
79
+
# queries: security-extended,security-and-quality
80
+
81
+
# If the analyze step fails for one of the languages you are analyzing with
82
+
# "We were unable to automatically build your code", modify the matrix above
83
+
# to set the build mode to "manual" for that language. Then modify this step
84
+
# to build your code.
85
+
# ℹ️ Command-line programs to run using the OS shell.
86
+
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
87
+
- if: matrix.build-mode == 'manual'
88
+
shell: bash
89
+
run: |
90
+
echo 'If you are using a "manual" build mode for one or more of the' \
91
+
'languages you are analyzing, replace this with the commands to build' \
0 commit comments