Skip to content

Commit e6c24e7

Browse files
Update README.md
1 parent 9512726 commit e6c24e7

File tree

1 file changed

+7
-63
lines changed

1 file changed

+7
-63
lines changed

README.md

Lines changed: 7 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,13 @@
1-
# React + TypeScript + Vite
1+
# Music Monday!
22

3-
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
3+
Every Monday a new judge is chosen and a new set of songs are submitted. Only one can take the crown of Music Prince.
44

5-
Currently, two official plugins are available:
5+
## Website
66

7-
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) for Fast Refresh
8-
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
7+
Check out https://musicmonday.kenjiang.ca/ to see some stats, view previous submissions, and see next week's judge.
98

10-
## Expanding the ESLint configuration
9+
## Discord Bot
1110

12-
If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
11+
The discord bot handles submissions and judging. Judging is a blind process, where the judge does not know who submitted which song (although it's usually fairly obvious).
1312

14-
```js
15-
export default tseslint.config([
16-
globalIgnores(['dist']),
17-
{
18-
files: ['**/*.{ts,tsx}'],
19-
extends: [
20-
// Other configs...
21-
22-
// Remove tseslint.configs.recommended and replace with this
23-
...tseslint.configs.recommendedTypeChecked,
24-
// Alternatively, use this for stricter rules
25-
...tseslint.configs.strictTypeChecked,
26-
// Optionally, add this for stylistic rules
27-
...tseslint.configs.stylisticTypeChecked,
28-
29-
// Other configs...
30-
],
31-
languageOptions: {
32-
parserOptions: {
33-
project: ['./tsconfig.node.json', './tsconfig.app.json'],
34-
tsconfigRootDir: import.meta.dirname,
35-
},
36-
// other options...
37-
},
38-
},
39-
])
40-
```
41-
42-
You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
43-
44-
```js
45-
// eslint.config.js
46-
import reactX from 'eslint-plugin-react-x'
47-
import reactDom from 'eslint-plugin-react-dom'
48-
49-
export default tseslint.config([
50-
globalIgnores(['dist']),
51-
{
52-
files: ['**/*.{ts,tsx}'],
53-
extends: [
54-
// Other configs...
55-
// Enable lint rules for React
56-
reactX.configs['recommended-typescript'],
57-
// Enable lint rules for React DOM
58-
reactDom.configs.recommended,
59-
],
60-
languageOptions: {
61-
parserOptions: {
62-
project: ['./tsconfig.node.json', './tsconfig.app.json'],
63-
tsconfigRootDir: import.meta.dirname,
64-
},
65-
// other options...
66-
},
67-
},
68-
])
69-
```
13+
Automatic updates are not supported yet, so winners and submissions must be added to `winners.csv` manually.

0 commit comments

Comments
 (0)