Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
ac53a81
ci: add CI workflows for linting and tests
timderes Apr 4, 2026
f7e0d15
ci: add Dependabot config for npm weekly updates
timderes Apr 4, 2026
227f3a7
ci: add CodeQL Advanced GitHub Action workflow
timderes Apr 4, 2026
5e115a0
chore: add dummy Vitest to verify test setup
timderes Apr 4, 2026
b996ac2
fix: use shorthand array type for listWindow
timderes Apr 4, 2026
5d999cd
Merge pull request #16 from timderes/td/ci-github-workflows
timderes Apr 4, 2026
62d3088
chore(deps): bump the mantine group with 5 updates
dependabot[bot] Apr 4, 2026
c851fee
fix: use mantine v9 useFullscreenDocument hook
timderes Apr 4, 2026
c79430a
Merge pull request #17 from timderes/dependabot/npm_and_yarn/mantine-…
timderes Apr 4, 2026
d8da2eb
chore(deps): bump the electron group with 4 updates
dependabot[bot] Apr 4, 2026
d6e462d
Merge pull request #19 from timderes/dependabot/npm_and_yarn/electron…
timderes Apr 4, 2026
6adbad3
chore(deps-dev): bump the dexie group with 2 updates
dependabot[bot] Apr 4, 2026
72bb2fd
Merge pull request #20 from timderes/dependabot/npm_and_yarn/dexie-3e…
timderes Apr 4, 2026
cd4b3f6
docs: add CONTRIBUTORS.md with contributor list
timderes Apr 4, 2026
35ce435
docs: add CONTRIBUTING.md
timderes Apr 4, 2026
459fb20
docs: add README for openSlalom
timderes Apr 4, 2026
258aeb5
fix(docs): fixed grammar in CONTRIBUTING.md
timderes Apr 4, 2026
34b56b1
docs: add bug report and feature request templates
timderes Apr 4, 2026
7a69d20
Merge pull request #28 from timderes/td/docs-add-docs
timderes Apr 4, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: Bug Report
about: Create a report to help us improve
title: ""
labels: bug
assignees: ""
---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**App & OS information**

- OS [e.g. Windows]
- openSlalom version [e.g. 0.1.0]
- Optional: add the logs created by openSlalom (on Windows: `%APPDATA%\openSlalom\logs`)

**Additional context**
Add any other context about the problem here.
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Feature Request
about: Suggest an idea for this project
title: ""
labels: enhancement
assignees: ""
---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
33 changes: 33 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
version: 2
updates:
- package-ecosystem: "npm"
directory: "/"
schedule:
interval: "weekly"
day: "monday"
time: "04:00"
open-pull-requests-limit: 10
groups:
# Group Mantine UI updates together to ensure consistency
mantine:
patterns:
- "@mantine/*"
- "postcss-preset-mantine"
# Group React and Next.js updates (often related)
framework:
patterns:
- "react"
- "react-dom"
- "next"
- "next-i18next"
- "nextron"
# Group Electron related packages
electron:
patterns:
- "electron"
- "electron-*"
# Group database related packages
dexie:
patterns:
- "dexie"
- "dexie-*"
99 changes: 99 additions & 0 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
# For most projects, this workflow file will not need changing; you simply need
# to commit it to your repository.
#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.
#
# ******** NOTE ********
# We have attempted to detect the languages in your repository. Please check
# the `language` matrix defined below to confirm you have the correct set of
# supported CodeQL languages.
#
name: "CodeQL Advanced"

on:
push:
branches: ["main"]
pull_request:
branches: ["main"]
schedule:
- cron: "30 12 * * 1"

jobs:
analyze:
name: Analyze (${{ matrix.language }})
# Runner size impacts CodeQL analysis time. To learn more, please see:
# - https://gh.io/recommended-hardware-resources-for-running-codeql
# - https://gh.io/supported-runners-and-hardware-resources
# - https://gh.io/using-larger-runners (GitHub.com only)
# Consider using larger runners or machines with greater resources for possible analysis time improvements.
runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
permissions:
# required for all workflows
security-events: write

# required to fetch internal or private CodeQL packs
packages: read

# only required for workflows in private repositories
actions: read
contents: read

strategy:
fail-fast: false
matrix:
include:
- language: javascript-typescript
build-mode: none
# CodeQL supports the following values keywords for 'language': 'actions', 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'rust', 'swift'
# Use `c-cpp` to analyze code written in C, C++ or both
# Use 'java-kotlin' to analyze code written in Java, Kotlin or both
# Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
# To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
# see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
# If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
# 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
steps:
- name: Checkout repository
uses: actions/checkout@v4

# Add any setup steps before running the `github/codeql-action/init` action.
# This includes steps like installing compilers or runtimes (`actions/setup-node`
# or others). This is typically only required for manual builds.
# - name: Setup runtime (example)
# uses: actions/setup-example@v1

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v4
with:
languages: ${{ matrix.language }}
build-mode: ${{ matrix.build-mode }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.

# 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
# queries: security-extended,security-and-quality

# If the analyze step fails for one of the languages you are analyzing with
# "We were unable to automatically build your code", modify the matrix above
# to set the build mode to "manual" for that language. Then modify this step
# to build your code.
# Command-line programs to run using the OS shell.
# See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
- name: Run manual build steps
if: matrix.build-mode == 'manual'
shell: bash
run: |
echo 'If you are using a "manual" build mode for one or more of the' \
'languages you are analyzing, replace this with the commands to build' \
'your code, for example:'
echo ' make bootstrap'
echo ' make release'
exit 1

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v4
with:
category: "/language:${{matrix.language}}"
34 changes: 34 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Lint and format code

# Remove the write permissions, see CodeQL `actions/missing-workflow-permissions`
permissions:
actions: write # Needed for caching npm dependencies
contents: read

on:
push:
branches: [main]
pull_request:
branches: [main]

jobs:
lint:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v6

- name: Use Node.js
uses: actions/setup-node@v6
with:
node-version: 24
cache: "npm"

- name: Install dependencies
run: npm ci

- name: Run ESLint
run: npm run lint

- name: Check formatting with Prettier
run: npm run format:check
31 changes: 31 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Run all tests

# Remove the write permissions, see CodeQL `actions/missing-workflow-permissions`
permissions:
actions: write # Needed for caching npm dependencies
contents: read

on:
push:
branches: [main]
pull_request:
branches: [main]

jobs:
test:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v6

- name: Use Node.js
uses: actions/setup-node@v6
with:
node-version: 24
cache: "npm"

- name: Install dependencies
run: npm ci

- name: Run tests
run: npm test
70 changes: 70 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# Contributing

**First of all, thank you for considering contributing to openSlalom! We welcome contributions from everyone. Whether it's a bug fix, a new feature, or improving documentation, your help is greatly appreciated!**

## Where to Start

The best place to start is by checking out the [Issues](https://github.com/timderes/open-slalom/issues). If an issue doesn't have an assigned contributor, feel free to claim it and start working on it!

You can also take a look at the [Projects](https://github.com/timderes/open-slalom/projects?query=is%3Aopen) tab to see if there are any ongoing tasks that you can contribute to.

### Look out for these issues

- <span style="color: #7057ff">**good first issue**</span>: These are usually smaller issues that are ideal for newcomers to the project. They are a great way to get familiar with the codebase and make your first contribution.

- <span style="color: #008672">**help wanted**</span>: Issues that need support or haven’t been assigned yet

### How to start the app in development mode

To start the app in development mode, you can use the following command:

**NOTE: The development and production builds don't share the profiles, match history and app settings!**

```bash
# 1. install dependencies
npm i

# 2. start the app in development mode
npm run dev
```

## How to Contribute

Before reporting a bug or suggesting a feature, please check the [Issues](https://github.com/timderes/open-slalom/issues) to see if it has already been reported or suggested. If it has, you can add any additional information or support to the existing issue.

Follow these steps to contribute:

1. Fork the repository and create a new branch for your contribution (e.g., `fix/bug-description` or `feat/new-feature`).
2. Make your changes and commit them with a clear and descriptive message.
3. Push your changes to your forked repository.
4. Open a pull request to the main repository and add any relevant details about your contribution.
5. Wait for feedback and make any necessary changes based on the review.

## How to report a bug

Use the **Bug Report Template** to create a new issue.

When reporting a bug, please provide as much detail as possible, including the latest logs created by openSlalom. You can find the logs in the following locations:

- **Windows:** `%APPDATA%\openSlalom\logs`

## How to suggest a feature

Use the **Feature Template** to create a new issue.

## How to add a new app language

Thanks for helping and taking the time to translate openSlalom into your language! If you want to contribute a new language, please follow these steps:

1. Fork the repository and create a new branch for your language (e.g. `feat/add-spanish-language`).

2. Open `next-i18next.config.js` and add your language code to the `locales` array. For example, if you want to add Spanish, you would add `'es'` to the array.
**NOTE: Use the `Set 1` language codes: [ISO 639 language codes](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes)!**

3. Create a new folder in the `renderer/public/locales` directory with the name of your language code (e.g., `es` for Spanish).

4. Copy the contents of the `en` folder into your new language folder and translate the JSON files into your language.

5. Commit your changes and push the branch to your forked repository.

6. Open a pull request to the main repository and add any relevant details.
5 changes: 5 additions & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Contributors

**openSlalom is developed and maintained by the following contributors. Thanks to everyone who has contributed to the project!**

- Tim Deres ([@timderes](https://github.com/timderes))
Loading
Loading