Skip to content

Commit 71e95e8

Browse files
rahim-jrrahim-jr
committed
docs: update README with project details and cleanup index.html
1 parent 9ac6bee commit 71e95e8

File tree

2 files changed

+48
-71
lines changed

2 files changed

+48
-71
lines changed

‎frontend/README.md‎

Lines changed: 34 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,47 @@
1-
# React + TypeScript + Vite
1+
# BGCE-Stream
22

3-
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
3+
A visually stunning audio streaming and voice chat platform built with React, Vite, Shadcn UI, and Tailwind CSS.
44

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

7-
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) (or [oxc](https://oxc.rs) when used in [rolldown-vite](https://vite.dev/guide/rolldown)) 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+
- **Audio Stream Room**: One broadcaster, unlimited listeners.
8+
- Interactive visualizer and status indicators.
9+
- Live chat for all participants.
10+
- **Voice Chat Room**: Peer-to-peer style voice communication.
11+
- Grid layout with speaking animations.
12+
- Individual participant controls.
13+
- **Modern UI**: Fully responsive design with dark mode support.
14+
- **Visuals**: Glassmorphism effects, smooth animations, and gradients.
915

10-
## React Compiler
16+
## Tech Stack
1117

12-
The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
18+
- **Frontend**: React, TypeScript, Vite
19+
- **Styling**: Tailwind CSS
20+
- **Components**: Shadcn UI (Radix Primitives)
21+
- **Icons**: Lucide React
22+
- **Routing**: React Router DOM
1323

14-
## Expanding the ESLint configuration
24+
## Getting Started
1525

16-
If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
26+
1. **Install Dependencies**
27+
```bash
28+
npm install
29+
```
1730

18-
```js
19-
export default defineConfig([
20-
globalIgnores(['dist']),
21-
{
22-
files: ['**/*.{ts,tsx}'],
23-
extends: [
24-
// Other configs...
31+
2. **Run Development Server**
32+
```bash
33+
npm run dev
34+
```
2535

26-
// Remove tseslint.configs.recommended and replace with this
27-
tseslint.configs.recommendedTypeChecked,
28-
// Alternatively, use this for stricter rules
29-
tseslint.configs.strictTypeChecked,
30-
// Optionally, add this for stylistic rules
31-
tseslint.configs.stylisticTypeChecked,
36+
3. **Build for Production**
37+
```bash
38+
npm run build
39+
```
3240

33-
// Other configs...
34-
],
35-
languageOptions: {
36-
parserOptions: {
37-
project: ['./tsconfig.node.json', './tsconfig.app.json'],
38-
tsconfigRootDir: import.meta.dirname,
39-
},
40-
// other options...
41-
},
42-
},
43-
])
44-
```
41+
## Contributing
4542

46-
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+
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
4744

48-
```js
49-
// eslint.config.js
50-
import reactX from 'eslint-plugin-react-x'
51-
import reactDom from 'eslint-plugin-react-dom'
45+
## License
5246

53-
export default defineConfig([
54-
globalIgnores(['dist']),
55-
{
56-
files: ['**/*.{ts,tsx}'],
57-
extends: [
58-
// Other configs...
59-
// Enable lint rules for React
60-
reactX.configs['recommended-typescript'],
61-
// Enable lint rules for React DOM
62-
reactDom.configs.recommended,
63-
],
64-
languageOptions: {
65-
parserOptions: {
66-
project: ['./tsconfig.node.json', './tsconfig.app.json'],
67-
tsconfigRootDir: import.meta.dirname,
68-
},
69-
// other options...
70-
},
71-
},
72-
])
73-
```
47+
[MIT](https://choosealicense.com/licenses/mit/)

‎frontend/index.html‎

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
<!doctype html>
22
<html lang="en">
3-
<head>
4-
<meta charset="UTF-8" />
5-
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
6-
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>frontend</title>
8-
</head>
9-
<body>
10-
<div id="root"></div>
11-
<script type="module" src="/src/main.tsx"></script>
12-
</body>
13-
</html>
3+
4+
<head>
5+
<meta charset="UTF-8" />
6+
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
7+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8+
<title>bgce-stream</title>
9+
</head>
10+
11+
<body>
12+
<div id="root"></div>
13+
<script type="module" src="/src/main.tsx"></script>
14+
</body>
15+
16+
</html>

0 commit comments

Comments
 (0)