Skip to content

Commit eda49b4

Browse files
committed
init v1
1 parent b1fefdb commit eda49b4

20 files changed

+7008
-0
lines changed

.eslintignore

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.DS_Store
2+
node_modules
3+
/build
4+
/.svelte-kit
5+
/package
6+
.env
7+
.env.*
8+
!.env.example
9+
10+
# Ignore files for PNPM, NPM and YARN
11+
pnpm-lock.yaml
12+
package-lock.json
13+
yarn.lock

.eslintrc.cjs

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
module.exports = {
2+
root: true,
3+
extends: [
4+
'eslint:recommended',
5+
'plugin:@typescript-eslint/recommended',
6+
'plugin:svelte/recommended',
7+
'prettier'
8+
],
9+
parser: '@typescript-eslint/parser',
10+
plugins: ['@typescript-eslint'],
11+
parserOptions: {
12+
sourceType: 'module',
13+
ecmaVersion: 2020,
14+
extraFileExtensions: ['.svelte']
15+
},
16+
env: {
17+
browser: true,
18+
es2017: true,
19+
node: true
20+
},
21+
overrides: [
22+
{
23+
files: ['*.svelte'],
24+
parser: 'svelte-eslint-parser',
25+
parserOptions: {
26+
parser: '@typescript-eslint/parser'
27+
}
28+
}
29+
]
30+
};

.gitignore

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.DS_Store
2+
node_modules
3+
/build
4+
/.svelte-kit
5+
/package
6+
.env
7+
.env.*
8+
!.env.example
9+
vite.config.js.timestamp-*
10+
vite.config.ts.timestamp-*

.npmrc

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
engine-strict=true
2+
resolution-mode=highest

.prettierignore

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.DS_Store
2+
node_modules
3+
/build
4+
/.svelte-kit
5+
/package
6+
.env
7+
.env.*
8+
!.env.example
9+
10+
# Ignore files for PNPM, NPM and YARN
11+
pnpm-lock.yaml
12+
package-lock.json
13+
yarn.lock

.prettierrc

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"useTabs": true,
3+
"singleQuote": true,
4+
"trailingComma": "none",
5+
"printWidth": 100,
6+
"plugins": ["prettier-plugin-svelte"],
7+
"pluginSearchDirs": ["."],
8+
"overrides": [{ "files": "*.svelte", "options": { "parser": "svelte" } }]
9+
}

README.md

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
Apologies for the confusion. Here's a readme for the VaderBoard Svelte leaderboard client project:
2+
3+
# VaderBoard Leaderboard
4+
5+
VaderBoard Leaderboard is a web application built with Svelte. It provides a dynamic leaderboard display for user and team events, allowing you to view and track scores in real-time.
6+
7+
![Vaderboard](/assets/vboard.png)
8+
9+
## Demo
10+
11+
![Vaderboard demo](/assets/vboard1.png)
12+
13+
## Installation
14+
15+
To install and run the VaderBoard Leaderboard project, follow the steps below:
16+
17+
1. Clone the repository:
18+
19+
```bash
20+
git clone https://github.com/v4zha/Vaderboard
21+
```
22+
23+
2. Navigate to the project directory:
24+
25+
```bash
26+
cd Vaderboard
27+
```
28+
29+
3. Install the dependencies using npm or yarn:
30+
31+
```bash
32+
npm install
33+
# or
34+
yarn install
35+
```
36+
37+
4. Start the development server:
38+
39+
```bash
40+
npm run dev
41+
# or
42+
yarn dev
43+
```
44+
45+
5. Access the VaderBoard Leaderboard in your web browser at `http://localhost:5000`.
46+
47+
## Usage
48+
49+
The VaderBoard Leaderboard application allows you to view and interact with the leaderboard for user and team events. Follow the steps below to use the application:
50+
51+
1. Ensure that the [VaderBoard Admin Panel](https://github.com/v4zha/Vaderboard-admin) is running and serving the necessary data for the leaderboard.
52+
53+
2. Open the VaderBoard Leaderboard application in your web browser.
54+
55+
3. If there is an active event, you will see the event details and a button to show or hide the event information.
56+
57+
4. Click on the "Show Event Info" button to display additional information about the event, such as event name, event ID, and event type.
58+
59+
5. The leaderboard table will show the position, name (either user or team name), and score for each participant.
60+
61+
## Customization
62+
63+
You can customize the VaderBoard Leaderboard application to fit your specific requirements. Here are some possible customization options:
64+
65+
- Modify the styling of the components by editing the CSS in the Svelte components or adding your own CSS classes.
66+
67+
- Add additional information or fields to the eventInfo object to display more details about the event.
68+
69+
- Implement additional features, such as filtering or sorting the leaderboard based on different criteria.
70+
71+
- Customize the transition effects or animations for the leaderboard entries.
72+
73+
Feel free to explore the codebase and make changes according to your needs : )

assets/vboard.png

1.89 MB
Loading

assets/vboard1.png

35.6 KB
Loading

0 commit comments

Comments
 (0)